Skip to content

Conversation

@chenchongbiao
Copy link

@chenchongbiao chenchongbiao commented Sep 4, 2025

1.mdbook v0.4.41 后修改了加载侧边栏目录的逻辑, 需要同步修改模板. 目前模板与部署时使用的 mdbook 版本不匹配导致侧边栏链接错误. 通过 mdbook init --theme 生成新模板替换目前模板.
2.giscus 客户端和语言切换按钮单独提交, 方便比对与模板的差异.
3.git restore 操作应该根据 po 文件的 PO-Revision-Date 字段, POT-Creation-Date 字段是创建时的时间, 后续更新 po 文件应该手动或者自动化工具更新 PO-Revision-Date 字段, 保证 git restore 还原 docs 文件夹到指定时间.
4.指定 mdbook 的版本, 避免后续 mdbook 更新版本与模板不匹配引入错误, 本地版本与部署版本保持一致, 方便发现问题.

link: rust-lang/mdBook#2414
fix #86

mdbook v0.4.41 后修改了加载侧边栏目录的逻辑,需要同步修改模板。目前模板与部署时使用的 mdbook 版本不匹配导致侧边栏链接错误。通过 mdbook init --theme 生成新模板替换目前模板。

link: rust-lang/mdBook#2414
@chenchongbiao
Copy link
Author

fixes #86

@RadxaYuntian
Copy link
Contributor

Fixes要写在PR正文或者提交消息里面才有效果

@chenchongbiao
Copy link
Author

Fixes要写在PR正文或者提交消息里面才有效果

Copy link
Contributor

@RadxaYuntian RadxaYuntian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

另外也要把src/share/rsdk/infra-package里面的docs workflow和devenv.lock更新,去使用devenv提供的mdbook

@chenchongbiao chenchongbiao force-pushed the 20250904-update-mdbook-version branch 2 times, most recently from 6ba6ba9 to 64f7872 Compare September 4, 2025 10:04
@chenchongbiao chenchongbiao force-pushed the 20250904-update-mdbook-version branch from 64f7872 to d4c28ee Compare September 5, 2025 02:06
@chenchongbiao
Copy link
Author

Copy link
Contributor

@RadxaYuntian RadxaYuntian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

不是说要用devenv的环境来配置mdbook,不要在workflow里面安装了么

https://devenv.sh/integrations/github-actions/#run-multiple-commands

@RadxaYuntian
Copy link
Contributor

另外如果devenv的安装有问题的话,可以参考这里在我们devcontainer里面运行,这里面会预装devenv

@chenchongbiao
Copy link
Author

另外如果devenv的安装有问题的话,可以参考这里在我们devcontainer里面运行,这里面会预装devenv

搞定了,没注意根根目录也配了个,只改了 rsdk/src/share/rsdk/infra-package 里面的

@RadxaYuntian
Copy link
Contributor

根目录的是rsdk自己实际使用的,usr/share里面是用于更新其他仓库的模板

@chenchongbiao
Copy link
Author

根目录的是rsdk自己实际使用的,usr/share里面是用于更新其他仓库的模板

1

@chenchongbiao chenchongbiao force-pushed the 20250904-update-mdbook-version branch from d4c28ee to 6e07b1a Compare September 5, 2025 03:28
@chenchongbiao
Copy link
Author

指定 mdbook 的版本, 避免后续 mdbook 更新版本与模板不匹配引入错误, 本地版本与部署版本保持一致, 方便发现问题.
workflows 使用 devenv 运行运行环境.
@chenchongbiao chenchongbiao force-pushed the 20250904-update-mdbook-version branch from 6e07b1a to 8f6b6ab Compare September 5, 2025 06:17
@RadxaYuntian RadxaYuntian added this pull request to the merge queue Sep 5, 2025
Merged via the queue into RadxaOS-SDK:main with commit e268161 Sep 5, 2025
54 checks passed
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.

rsdk 文档链接错误

3 participants