Skip to content

docs: fix relative links to documentation guides - #5

Merged
potterwhite merged 1 commit into
mainfrom
br_v0.5.3
Dec 30, 2025
Merged

potterwhite merged 1 commit into
mainfrom
br_v0.5.3

Conversation

@potterwhite

Copy link
Copy Markdown
Owner

📝 Summary

This PR fixes broken navigation links in the English and Chinese README files that were introduced during the recent docs/ folder restructuring.

🛠️ Changes

  • README.md: Updated the "Add New SoC" link to correctly point to ./docs/en/ADD_NEW_SOC.md.
  • docs/zh-cn/README_ZH_CN.md: Updated links to reference the co-located _ZH_CN.md files within the docs/zh-cn/ directory instead of trying to reach out to the root directory.

🔍 Test Plan

  • Clicked the "How to Add Support for a New SoC" link in the main README; verifies it opens the English guide.
  • Clicked "构建系统详解" and "添加对新 SoC 的支持" in the Chinese README; verifies they open the correct Chinese guides.

- Update `README.md`: Correct link to point to `docs/en/ADD_NEW_SOC.md` (English version) instead of the root or Chinese path.
- Update `docs/zh-cn/README_ZH_CN.md`: Fix relative paths to point correctly to `BUILD_SYSTEM_ZH_CN.md` and `ADD_NEW_SOC_ZH_CN.md` within the `zh-cn` directory.

Signed-off-by: PotterWhite <themanuknowwhom@outlook.com>
@potterwhite
potterwhite merged commit 909dc3f into main Dec 30, 2025
1 check passed
@potterwhite
potterwhite deleted the br_v0.5.3 branch December 30, 2025 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant