docs(mofa-doc): refine docs quality checks and versioned docs guidance (#233)#288
Merged
lijingrs merged 5 commits intomofa-org:mainfrom Feb 23, 2026
Merged
Conversation
…mofa-org#233) Co-authored-by: Rahul-2k4 <216878448+Rahul-2k4@users.noreply.github.com>
Docs: Add versioned docs page and Agent Hub scope clarification (issue mofa-org#233)
Contributor
Author
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.
📋 Summary
Refines
docs/mofa-docin the existing MoFA RS docs system (mdBook), focusing on documentation quality and maintainability onmain.This PR intentionally excludes Agent Hub implementation and keeps scope on:
🔗 Related Issues
Closes #233
Related to #244
🧠 Context
Maintainer guidance clarified that Agent Hub is not a current MoFA RS deliverable. This PR follows that guidance and keeps work inside the existing
docs/mofa-docstructure already present in the repository.The goal is to reduce docs regressions and improve contributor DX without introducing new ecosystems or infra.
🛠️ Changes
docs/mofa-doc/scripts/check-internal-links.sh.github/workflows/ci.ymldocs/mofa-doc/src/api-reference/...docs/mofa-doc/src/zh/api-reference/...docs/mofa-doc/src/zh/...pagesdocs/mofa-doc/README.mddocs/mofa-doc/src/appendix/versioned-docs.mddocs/mofa-doc/src/zh/appendix/versioned-docs.mddocs/mofa-doc/src/SUMMARY.mddocs/mofa-doc/src/zh/SUMMARY.mddocs/mofa-doc/src/appendix/README.mddocs/mofa-doc/src/zh/appendix/README.md🧪 How you Tested
docs/mofa-doc/scripts/check-internal-links.shcd docs/mofa-doc && ./scripts/build-docs.shtest -f docs/mofa-doc/book/index.htmltest -f docs/mofa-doc/book/zh/index.html📸 Screenshots / Logs (if applicable)
Key local verification output:
Internal link check passedBuilt docs successfully:English: .../docs/mofa-doc/bookChinese: .../docs/mofa-doc/book/zh🧹 Checklist
Code Quality
cargo fmtruncargo clippypasses without warningsTesting
cargo testpasses locally without any errorDocumentation
PR Hygiene
main🚀 Deployment Notes (if applicable)
No runtime deployment changes.
Docs CI now includes internal-link validation before merge.
🧩 Additional Notes for Reviewers
Agent Hub implementation is intentionally out of scope per maintainer direction. The “Scope Note: Agent Hub” in versioned-docs pages is included to prevent future scope confusion for contributors.