docs: move doxygen/ to zh-cn/api and zh-cn/device_dev_guide#535
Merged
tanghao-xiaomi merged 1 commit intoMay 9, 2026
Merged
Conversation
tanghao-xiaomi
requested review from
TangMeng12,
aiduxiaoxiong,
smile0425 and
yanxingyu17
as code owners
Collaborator
Author
|
/check-cla |
✅ CLA Verification Complete@tanghao-xiaomi All contributors have signed the CLA!
📋 View detailed check results: Action Run #25586801031 Your pull request can now proceed with the review process! 🎉 |
Reorganize the legacy docs/doxygen/ directory so that file locations match both the actual content type and the existing bilingual docs layout (zh-cn/ for Chinese, en/ for English). == Why == Since open-vela#526 deprecated the Sphinx/Doxygen build pipeline, all files under docs/doxygen/ are plain hand-written Markdown. The directory name is misleading, and the content is currently Chinese-only while the rest of docs/ uses docs/zh-cn and docs/en mirrors. The directory also mixed two unrelated content types: - docs/doxygen/api/ — API reference - docs/doxygen/system_debug_tools/ — Chinese developer guides == What == - git mv docs/doxygen/api → docs/zh-cn/api (81 files) - git mv docs/doxygen/system_debug_tools → docs/zh-cn/device_dev_guide/system_debug_tools (20 files) - rmdir docs/doxygen (now empty) Pure rename / move; no content changes. 'grep -rn doxygen/' over the remaining Markdown and YAML returns no hits. == Notes == - API documentation is now at docs/zh-cn/api/, consistent with the rest of the Chinese docs tree. The English mirror at docs/en/api/ will be added in a follow-up PR once translations are ready. - system_debug_tools/ joins the existing Chinese dev-guide tree alongside kernel/, driver/, connection/, media/, etc. - The system_debug_tools/ files are currently wrapped in Doxygen-style comment blocks; that formatting issue is tracked as a separate cleanup task and is not addressed here.
tanghao-xiaomi
force-pushed
the
rename-doxygen-to-api
branch
from
0747c63 to
72a6c80
Compare
tanghao-xiaomi
changed the title
Collaborator
Author
|
/check-cla |
✅ CLA Verification Complete@tanghao-xiaomi All contributors have signed the CLA!
📋 View detailed check results: Action Run #25586900103 Your pull request can now proceed with the review process! 🎉 |
TangMeng12
approved these changes
May 9, 2026
yanxingyu17
approved these changes
May 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Reorganize the legacy
docs/doxygen/directory so that file locations match both the actual content type and the existing bilingual docs layout (zh-cn/for Chinese,en/for English).Motivation
Since #526 deprecated the Sphinx/Doxygen build pipeline, all files under
docs/doxygen/are plain hand-written Markdown. The directory name is misleading, and the content is currently Chinese-only while the rest ofdocs/uses adocs/zh-cn/docs/enbilingual layout.The directory also mixed two unrelated content types:
docs/doxygen/api/— API reference documentsdocs/doxygen/system_debug_tools/— Chinese developer guides (crash recovery, performance analysis, runtime diagnostics)Changes
docs/doxygen/api/docs/zh-cn/api/docs/doxygen/system_debug_tools/docs/zh-cn/device_dev_guide/system_debug_tools/docs/doxygen/101 files changed, 0 insertions, 0 deletions — every change is an
R100pure rename.Verification
git diff-tree -r -M HEAD~1 HEADconfirms every file isR100(100% rename, no content change)grep -rn 'doxygen/'over all committed Markdown and YAML returns no hits — no cross-references to updateFollow-up
docs/en/api/will be added in a follow-up PR once translations are ready\[ English | 简体中文 \]) will be added once both sides existsystem_debug_tools/files are currently wrapped in Doxygen-style comment blocks; the format cleanup is tracked separately