Repository navigation
docs: register RVV acceleration page in sidebar and add English version - #218
Open
yangwenjie1231 wants to merge 1 commit into
Open
yangwenjie1231 wants to merge 1 commit into
yangwenjie1231 wants to merge 1 commit into
Conversation
PR sipeed#176 added `docs/doc/zh/pro/rvv.md` but never registered it in `sidebar.yaml`. teedoc builds a page for every `.md` file, so the page was generated and reachable by direct URL, but it had no entry in the navigation and became an orphan page. The language switcher also pointed at an English page that did not exist, returning 404. - register `pro/rvv.md` in both `docs/doc/zh/sidebar.yaml` and `docs/doc/en/sidebar.yaml` - add the missing English version `docs/doc/en/pro/rvv.md` - tidy up the Chinese page: merge the duplicated sections, drop the stray top-level headings so the page has a single H1, fix a link broken by a full-width parenthesis, and rewrite the release-notes framing into normal document form - move the performance chart into `docs/doc/assets/` instead of hotlinking maixhub, matching how the rest of the docs reference images
This branch has not been deployed
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
1 participant
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.
问题
PR #176 新增了
docs/doc/zh/pro/rvv.md，但没有在sidebar.yaml里登记。teedoc 会为每个
.md生成页面，而导航树由sidebar.yaml单独决定 —— 两件事互相独立。结果是页面确实被构建了、直链能打开，却在导航里没有任何入口，成了孤立页面：https://wiki.sipeed.com/maixpy/doc/zh/pro/rvv.html→ 200，标题「使用RVV加速」，正文完整另外，中文页右上角的语言切换按钮会无条件指向
/maixpy/doc/en/pro/rvv.html，而英文文件并不存在 → 切英文 404。改动
导航
docs/doc/zh/sidebar.yaml、docs/doc/en/sidebar.yaml：把pro/rvv.md登记进「进阶」/「Advanced」分组英文版
docs/doc/en/pro/rvv.md：新增中文页内容整理（920 → 485 行）
title冲突导致大纲层级错乱，已降级；现在整页只有 1 个 H1维护者：yangwenjie1231（https://github.com/yangwenjie1231）中的全角）被自动链接吞进 URL，实际生成https://github.com/yangwenjie1231%EF%BC%89（404），已修正图片
docs/doc/assets/rvv_performance_comparison.jpg：性能对比图原本是 maixhub 外链，仓库里其余图片引用都走../../assets/，已转存进仓库并改用相对路径（顺带裁掉了原文件 JPEG 结束标记后的 26 字节 CDN 附加数据）技术内容（错误信息原文、编译参数、路径、示例代码）全部保留，未做删减。
验证
本地用 teedoc 完整构建（
build ok，exit 0），核对产物 HTML：Build OS后）侧边栏产物片段（取自相邻页面
compile_os.html，避免只看目标页造成误判）：关联：原 PR #176