fix(docs): fix relative repo links in built pages - #315
Open
ooooo-create wants to merge 1 commit into
Open
ooooo-create wants to merge 1 commit into
ooooo-create wants to merge 1 commit into
Conversation
ooooo-create
requested review from
NINGBENZHE and
Yangruipis
as code owners
September 14, 2026 13:49
Nyanpasu 审查看板审查状态: ✅ 已通过 审查版本: 审查完成,未发现需修改的问题。文档构建及后处理通过,中英文架构页各 18 个仓库链接与 9 个链接边界用例验证通过,4 项 CI 检查通过。仅涉及文档配置,未运行需多节点 GPU 的集成测试。 没有未解决的审查问题。
Powered by Nyanpasu with gpt-6-astra medium, please check the suggestions carefully.
|
rai-studio-bot
approved these changes
Sep 14, 2026
rai-studio-bot
left a comment
There was a problem hiding this comment.
已完成对 3a5545839f043d5efae4910ab47d4880b6445df0 的审查,可以合入。文档构建和后处理通过,中英文架构页各 18 个仓库链接及 9 个链接边界用例验证通过,站内链接保持正常;4 项 CI 检查均通过。本次仅涉及文档配置,未运行需多节点 GPU 的集成测试。
Powered by Nyanpasu with gpt-6-astra medium, please check the suggestions carefully.
# 🐛 Bug Fix - Rewrite relative Markdown links to existing repository files outside docs/ before VitePress applies HTML link normalization. - Use GitHub blob/main URLs for files and tree/main URLs for directories, preserving query strings and fragments. - Keep documentation links and missing or out-of-repository targets unchanged. ## Validation - Run pre-commit run --all-files --show-diff-on-failure successfully. - Build the VitePress site and verify the generated source links in both locales. - Confirm the train.py file and rollout directory URLs are accessible on GitHub. Fixes redai-studio#313
ooooo-create
force-pushed
the
fix/docs-source-links-313
branch
from
September 15, 2026 14:37
3a55458 to
96945c6
Compare
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.
What
Fix relative Markdown links to repository files and directories outside
docs/in the generated documentation site.Why
Links such as
../../../relax/entrypoints/train.pycurrently become invalid site URLs ending intrain.py.html. Keep the relative links in Markdown usable on GitHub while making them work in the built site.Fixes #313
How
docs/, generate GitHubblob/mainURLs for files andtree/mainURLs for directories.Testing
pre-commit run --all-filespassesTests pass (
pytest tests/)New tests added (if applicable)
Documentation updated (if applicable)
All hooks passed with
pre-commit run --all-files --show-diff-on-failure.Production build and postprocessing passed:
node node_modules/vitepress/bin/vitepress.js build docs && node docs/fix-chunk-names.js.Verified 18 generated GitHub repository links in each of the English and Chinese architecture pages, including the
train.pyfile androllout/directory. Internal documentation links still resolve to.htmlpages.Opened the generated GitHub file and directory URLs successfully.
Python and multi-node GPU integration tests were not run because this change only affects VitePress configuration. No new test files or Markdown content changes were needed.
Type of Change
Screenshots / Logs