docs: fix broken documentation links by adding /en/ language prefix#986
docs: fix broken documentation links by adding /en/ language prefix#986garrett4wade merged 3 commits intomainfrom
Conversation
After docs site restructured for multilingual support (en/zh), all documentation page URLs without the language prefix now return 404. - Add /en/ prefix to 35+ doc links across README, CONTRIBUTING, blog, examples, and docs files - Fix typo in blog: /references/ -> /reference/ (plural to singular) - Use /zh/ prefix for Chinese docs cross-references - Auto-format markdown via mdformat pre-commit hook Closes #984
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request resolves widespread broken documentation links throughout the repository. The issue arose from a recent restructuring of the documentation site to support multiple languages, which introduced Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
Add 中文文档 link pointing to /zh/ docs site in the header nav bar, alongside the existing Documentation link (now explicitly /en/).
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request correctly fixes numerous broken documentation links by adding the appropriate language prefixes (/en/ or /zh/). The changes are thorough and align with the multilingual restructuring of the documentation site. I have one suggestion for the README.md file to improve link consistency by using relative paths, which would make the repository's documentation links more maintainable.
Note: Security Review has been skipped due to the limited scope of the PR.
garrett4wade
force-pushed
the
fw/fix-doc-link
branch
from
070ab66 to
ae21793
Compare
The root URL auto-redirects, no need for explicit /en/ path.
garrett4wade
force-pushed
the
fw/fix-doc-link
branch
from
ae21793 to
8f7e332
Compare
…986) * docs: fix broken documentation links by adding /en/ language prefix After docs site restructured for multilingual support (en/zh), all documentation page URLs without the language prefix now return 404. - Add /en/ prefix to 35+ doc links across README, CONTRIBUTING, blog, examples, and docs files - Fix typo in blog: /references/ -> /reference/ (plural to singular) - Use /zh/ prefix for Chinese docs cross-references - Auto-format markdown via mdformat pre-commit hook Closes #984 * docs: add Chinese documentation link to README header Add 中文文档 link pointing to /zh/ docs site in the header nav bar, alongside the existing Documentation link (now explicitly /en/). * docs: revert Documentation link to root URL The root URL auto-redirects, no need for explicit /en/ path.
…nclusionAI#986) * docs: fix broken documentation links by adding /en/ language prefix After docs site restructured for multilingual support (en/zh), all documentation page URLs without the language prefix now return 404. - Add /en/ prefix to 35+ doc links across README, CONTRIBUTING, blog, examples, and docs files - Fix typo in blog: /references/ -> /reference/ (plural to singular) - Use /zh/ prefix for Chinese docs cross-references - Auto-format markdown via mdformat pre-commit hook Closes inclusionAI#984 * docs: add Chinese documentation link to README header Add 中文文档 link pointing to /zh/ docs site in the header nav bar, alongside the existing Documentation link (now explicitly /en/). * docs: revert Documentation link to root URL The root URL auto-redirects, no need for explicit /en/ path.
…nclusionAI#986) * docs: fix broken documentation links by adding /en/ language prefix After docs site restructured for multilingual support (en/zh), all documentation page URLs without the language prefix now return 404. - Add /en/ prefix to 35+ doc links across README, CONTRIBUTING, blog, examples, and docs files - Fix typo in blog: /references/ -> /reference/ (plural to singular) - Use /zh/ prefix for Chinese docs cross-references - Auto-format markdown via mdformat pre-commit hook Closes inclusionAI#984 * docs: add Chinese documentation link to README header Add 中文文档 link pointing to /zh/ docs site in the header nav bar, alongside the existing Documentation link (now explicitly /en/). * docs: revert Documentation link to root URL The root URL auto-redirects, no need for explicit /en/ path.
1 participant
Description
Fix all broken documentation links across the repository. After the docs site was
restructured for multilingual support (en/zh), all documentation page URLs without
the language prefix now return 404. This adds the
/en/prefix to 35+ doc linksacross 7 files and fixes one typo (
/references/→/reference/).Related Issue
Fixes #984
Type of Change
Checklist
jb build docs/gemini review)Breaking Change Details (if applicable):
N/A
Additional Context
Root cause: The documentation site was restructured from a single-language setup
to a multilingual setup with
/en/and/zh/prefixes. A rootindex.htmlauto-redirectsto
/en/, so the base URLhttps://inclusionai.github.io/AReaL/still works, but alldeep links like
/tutorial/quickstart.htmlnow return 404 without the/en/prefix.Changes by file:
README.mdCONTRIBUTING.mdblog/AReaL_v0_3.mdreferences/reproduce→reference/reproduce(typo fix + prefix)docs/en/version_history.md/en/prefixdocs/zh/version_history.md/zh/prefix (Chinese docs link to Chinese version)examples/countdown/README.mdexamples/tau2/README.mdVerification: Confirmed via HTTP that old URLs (without
/en/) return 404 and newURLs (with
/en/) return 200.