Repository navigation
docs: restructure i18n folders and add 'Add New SoC' guide - #4
Merged
Merged
Conversation
- Refactor `docs/` directory structure: separate content into `docs/en/` and `docs/zh-cn/` for better localization management. - Add comprehensive guide "How to Add Support for a New SoC" (`ADD_NEW_SOC`) in both English and Chinese. - Covers Toolchain creation, Environment setup (.env), External Dependencies (Sherpa-Onnx/RKNN), and CMakePresets registration. - Add deep dive documentation "ArcForge Build System Explained" (`BUILD_SYSTEM`) visualizing the CMake lifecycle and architecture. - Update `README.md` and `docs/zh-cn/README_ZH_CN.md`: - Fix relative links to match the new directory structure. - Add Mermaid architecture diagrams and updated "Quick Start" sections. - Add "Supporting New Platforms" section. Closes: #4
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
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.
Description:
📝 Summary
This PR restructures the documentation directory to support proper internalization (i18n) by separating English and Chinese content. It also introduces two major documentation guides requested by the community and updates the root
README.mdto reflect these changes.🛠️ Changes
docs/->docs/en/&docs/zh-cn/ADD_NEW_SOC.md: A step-by-step tutorial on adding new cross-compilation targets (SoCs) via the.envandCMakePresets.jsonsystem.BUILD_SYSTEM.md: A technical deep dive into the project's Modern CMake architecture, including Mermaid diagrams for the build lifecycle and module topology.README.md.🔍 Test Plan
README.mdrenders correctly on GitHub.🔗 Linked Issues
Closes # (Issue ID if applicable)