Repository navigation
docs: reuse readmes for documentation homepages. - #2475
Conversation
- Link the English and Chinese homepages to the root READMEs. - Adapt homepage metadata, image paths, language links, and badges. - Remove the multimodal support pages and their incoming links. - Rebuild documentation when root READMEs or assets change.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📝 Walkthrough
Merge Risk: ⚪ Minimal · up to No confirmed issue blocks the documentation homepage change; it is ready for normal merge checks. Security Architecture Review
Pre-merge checks |
  |
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Docstring Coverage |  |
Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 5 files. (4 skipped: 4… | Write docstrings for the functions missing them to satisfy the coverage threshold. |
✅ Passed checks (4 passed)
-
Check name Status Explanation Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Title check The title clearly identifies the main change: reusing README files for documentation homepages. It is concise, specific, and follows the repository title format. Description check The description follows the required structure and clearly explains the homepage symlinks, metadata handling, Markdown transformations, workflow changes, removed pages, tests, and validation results.
Full details: Docstring Coverage
-
Explanation
Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 5 files. (4 skipped: 4 unsupported.)
- Fix all pre-merge checks with AI
✨ Finishing Touches
-
-
-
-
🧪 Generate unit tests (beta)
-
-
-
-
- Create a new PR
-
-
-
-
-
-
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Comment @coderabbitai help to get the list of available commands.
💡 Codex Review Normalize the homepage path before matching
On native Windows with Git symlink support enabled, Node supplies Track README commits in homepage update dates
After a later README-only edit—the update workflow documented by this change—the page body follows this symlink, but Starlight's enabled ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
💡 Codex Review Derive homepage timestamps from the README history
When a later commit edits only either README (a case both ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 669641e328
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
669641e to
7aea22b
Compare
2 participants
Description
The documentation homepages duplicate the repository READMEs and can drift when the project overview changes. Replace the English and Chinese
index.mdfiles with relative symlinks toREADME.mdandREADME_zh.md, so editing a README updates the corresponding homepage.The docs loader supplies homepage metadata and disables the last-updated footer on the English and Chinese homepages. A Markdown plugin adapts image paths and language links. Keep badges in a centered row with wrapping. Both root READMEs use the same Shields DeepWiki badge, preserving its destination and fixing the image in GitHub README rendering, documentation homepages, and copied Markdown. Include root README and asset changes in documentation build and deployment triggers, and document the editing workflow.
Remove the English and Chinese Multimodal Support pages and clean up the links from the vision API guides. Promote the README News headings to match the other homepage sections.
Related Issues
None.
Change Type
Pull Request Checklist
PR Title and Commit Messages
<type>: <subject>.Pre-commit Checks
pre-commitby runningpip install pre-commitor an equivalent command.pre-commit install.Self Review
.agents/skills/code-review/references/custom-code-style.md, especially code written or assisted by AI.mainbranch.Build and Test Coverage
Reviewer Notes
Validation:
npm run check: 0 errors, 0 warnings, 0 hints.npm run build -- --force: 148 pages built.python3 -m pre_commit run: passed for the staged changes.git diff --cached --check: passed./en/and/zh/in Safari and confirmed all five badges display in one centered row.Summary by CodeRabbit
mainwhen either README or assets change.