🔗 docs(readme): update documentation links to new site routing

[t0ng7u]

• Replace legacy docs.newapi.pro paths with the new /{lang}/docs/... structure across all README translations
• Point key sections (installation, env vars, API, support, features) to their new locations
• Ensure language-specific links use the correct locale prefix (zh/en/ja) and keep FR aligned with English routes

close: #2485

Summary by CodeRabbit

• Documentation
  • Localized and updated documentation links across README files (English, French, Japanese, Chinese), routing navigation, installation, API, environment, feature, and support references to language-specific docs.
  • Adjusted interface, feature, and “complete configuration” links and fast-navigation anchors to point to corresponding language-prefixed documentation pages.
  • Editorial link-only changes; no runtime or API behavior altered.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Multiple README files (Chinese, English, French, Japanese) updated to replace generic or broken documentation links with language-prefixed documentation paths (e.g., /zh/docs/, /en/docs/, /ja/docs/); content structure and wording largely preserved, no code or API changes.

Changes

Cohort / File(s)	Summary
Language-specific README link updates README.md, README.en.md, README.fr.md, README.ja.md	Replaced generic/document-root documentation links with localized language-prefixed targets across installation, environment variables, API, support, features, model/interface lists, and navigation anchors. No behavioral or exported-API changes; URL/path substitutions only.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

• Consistent, repetitive URL replacements across README files.
• Areas to spot-check: long anchor targets and deep paths (e.g., individual interface or feature anchors) to ensure no typos and that anchors exist on target pages.

Poem

🐰 I hopped through links, both near and far,
Swapped paths to languages like stars,
No more 404s to mar the view,
Multilingual docs — neat and true! ✨

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly describes the main change: updating documentation links to new site routing structure across README files.
Linked Issues check	✅ Passed	The PR successfully addresses issue #2485 by updating broken README links from legacy paths to new /{lang}/docs structure with proper locale prefixes.
Out of Scope Changes check	✅ Passed	All changes are scoped to README files with documentation link updates; no unrelated code or configuration modifications detected.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/readme-update-doc-links-new-routing

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.fr.md (1)

250-250: Minor French typography fix needed.

Per French typography conventions, a space is required before opening parentheses in compound terms. Update Midjourney-Proxy(Plus) to Midjourney-Proxy (Plus).

🔎 Proposed fix

-| 🎨 Midjourney-Proxy | [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy) | [Documentation](https://docs.newapi.pro/en/docs/guide/console/drawing-log) |
+| 🎨 Midjourney-Proxy | [Midjourney-Proxy (Plus)](https://github.com/novicezk/midjourney-proxy) | [Documentation](https://docs.newapi.pro/en/docs/guide/console/drawing-log) |

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d8aa327 and d6e97ab.

📒 Files selected for processing (4)

• README.en.md (7 hunks)
• README.fr.md (7 hunks)
• README.ja.md (7 hunks)
• README.md (7 hunks)

🧰 Additional context used

🪛 LanguageTool

README.fr.md

[typographical] ~149-~149: Pas de correspondance fermante ou ouvrante pour le caractère « ] »
Context: ...de déploiement, veuillez vous référer à [Guide de déploiement](https://docs.newap...

(UNPAIRED_BRACKETS)

---

[grammar] ~153-~153: Il y a peut-être une erreur ici
Context: ...wapi.pro/en/docs/installation) --- ## 📚 Documentation

### 📖 [Documentation officielle](https://do...

(QB_NEW_FR)

---

[grammar] ~161-~161: Typographie
Context: ...ntumNous/new-api)

Navigation rapide: | Catégorie | Lien | |------|------| | ?...

(QB_NEW_FR_OTHER_ERROR_IDS_MISSING_ORTHOGRAPHY_SPACE)

---

[grammar] ~175-~175: Il y a peut-être une erreur ici
Context: ...ki/basic-concepts/features-introduction) | ### 🎨 Fonctions principales | Fonctionnali...

(QB_NEW_FR)

---

[typographical] ~203-~203: Pas de correspondance fermante ou ouvrante pour le caractère « ] »
Context: ...rise en charge des formats d'API:** - ⚡ [OpenAI Responses](https://docs.newapi.pr...

(UNPAIRED_BRACKETS)

---

[typographical] ~205-~205: Pas de correspondance fermante ou ouvrante pour le caractère « ] »
Context: ...realtime-session) (y compris Azure) - ⚡ [Claude Messages](https://docs.newapi.pro...

(UNPAIRED_BRACKETS)

---

[typographical] ~206-~206: Pas de correspondance fermante ou ouvrante pour le caractère « ] »
Context: ...s/api/ai-model/chat/create-message) - ⚡ [Google Gemini](https://docs.newapi.pro/e...

(UNPAIRED_BRACKETS)

---

[typographical] ~245-~245: Pas de correspondance fermante ou ouvrante pour le caractère « ] »
Context: ...ur les détails, veuillez vous référer à [Documentation de l'API - Interface de re...

(UNPAIRED_BRACKETS)

---

[style] ~245-~245: Un tiret long ou un autre signe de ponctuation plus approprié, car le trait d’union ne s’utilise que pour former un mot.
Context: ...llez vous référer à [Documentation de l'API - Interface de relais](https://docs.newapi.pro/en/d...

(TIRET_LONG_1)

---

[typographical] ~250-~250: Une espace est nécessaire.
Context: ...- | | 🎨 Midjourney-Proxy | [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjo...

(PARENTHESES)

---

[typographical] ~308-~308: Pas de correspondance fermante ou ouvrante pour le caractère « ] »
Context: ...alse` | 📖 Configuration complète: [Documentation des variables d'environnem...

(UNPAIRED_BRACKETS)

---

[typographical] ~440-~440: Pas de correspondance fermante ou ouvrante pour le caractère « ] »
Context: ...hub.com/Calcium-Ion/new-api/issues)** • **[Dernière version](https://github.com/Cal...

(UNPAIRED_BRACKETS)

🔇 Additional comments (4)

README.ja.md (1)

149-170: Localization updates look good across all sections.

All documentation links have been consistently updated to use /ja/docs/ paths. The language-specific routing is applied uniformly from deployment guides through API documentation, features, and support sections.

Also applies to: 205-209, 255-263, 272-282, 317-317, 415-420, 449-449

README.fr.md (1)

149-170: Language routing is correctly aligned with English documentation paths.

All French README links consistently use /en/docs/ paths as intended per the PR objective ("keep FR aligned with English routes"). Documentation links across installation, API, FAQ, and community sections are properly updated.

Also applies to: 203-207, 245-272, 308-308, 408-411, 440-440

README.md (1)

149-170: Chinese localization with /zh/docs paths is consistent throughout.

All documentation links have been uniformly updated to use /zh/docs/ routing across all sections including deployment, API documentation, model interfaces, and community support.

Also applies to: 205-209, 250-259, 268-277, 313-313, 415-420, 447-447

README.en.md (1)

149-170: English documentation links are consistently routed to /en/docs paths.

All documentation references across deployment guides, API documentation, model support, and help sections have been properly updated to use /en/docs/ routing.

Also applies to: 204-208, 249-258, 267-276, 312-312, 414-417, 446-446

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d6e97ab and 470e030.

📒 Files selected for processing (4)

• README.en.md (7 hunks)
• README.fr.md (7 hunks)
• README.ja.md (7 hunks)
• README.md (7 hunks)

🧰 Additional context used

🪛 LanguageTool

README.fr.md

[typographical] ~149-~149: Pas de correspondance fermante ou ouvrante pour le caractère « ] »
Context: ...de déploiement, veuillez vous référer à [Guide de déploiement](https://docs.newap...

(UNPAIRED_BRACKETS)

---

[grammar] ~153-~153: Il y a peut-être une erreur ici
Context: ...wapi.pro/en/docs/installation) --- ## 📚 Documentation

### 📖 [Documentation officielle](https://do...

(QB_NEW_FR)

---

[grammar] ~161-~161: Typographie
Context: ...ntumNous/new-api)

Navigation rapide: | Catégorie | Lien | |------|------| | ?...

(QB_NEW_FR_OTHER_ERROR_IDS_MISSING_ORTHOGRAPHY_SPACE)

---

[grammar] ~175-~175: Il y a peut-être une erreur ici
Context: ...ki/basic-concepts/features-introduction) | ### 🎨 Fonctions principales | Fonctionnali...

(QB_NEW_FR)

---

[typographical] ~203-~203: Pas de correspondance fermante ou ouvrante pour le caractère « ] »
Context: ...rise en charge des formats d'API:** - ⚡ [OpenAI Responses](https://docs.newapi.pr...

(UNPAIRED_BRACKETS)

---

[typographical] ~205-~205: Pas de correspondance fermante ou ouvrante pour le caractère « ] »
Context: ...realtime-session) (y compris Azure) - ⚡ [Claude Messages](https://docs.newapi.pro...

(UNPAIRED_BRACKETS)

---

[typographical] ~206-~206: Pas de correspondance fermante ou ouvrante pour le caractère « ] »
Context: ...s/api/ai-model/chat/create-message) - ⚡ [Google Gemini](https://doc.newapi.pro/en...

(UNPAIRED_BRACKETS)

---

[typographical] ~245-~245: Pas de correspondance fermante ou ouvrante pour le caractère « ] »
Context: ...ur les détails, veuillez vous référer à [Documentation de l'API - Interface de re...

(UNPAIRED_BRACKETS)

---

[grammar] ~245-~245: Envisagez un remplacement
Context: ...uillez vous référer à [Documentation de l'API - Interface de relais](https://docs.newapi.pro/en/d...

(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_PUNCTUATION_DASH_–)

---

[typographical] ~250-~250: Une espace est nécessaire.
Context: ...- | | 🎨 Midjourney-Proxy | [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjo...

(PARENTHESES)

---

[typographical] ~308-~308: Pas de correspondance fermante ou ouvrante pour le caractère « ] »
Context: ...alse` | 📖 Configuration complète: [Documentation des variables d'environnem...

(UNPAIRED_BRACKETS)

---

[typographical] ~440-~440: Pas de correspondance fermante ou ouvrante pour le caractère « ] »
Context: ...hub.com/Calcium-Ion/new-api/issues)** • **[Dernière version](https://github.com/Cal...

(UNPAIRED_BRACKETS)

🔇 Additional comments (8)

README.ja.md (2)

149-149: ✓ Language-specific paths applied correctly.

The Japanese README consistently uses /ja/docs/ prefix across installation, documentation, navigation, and feature sections, replacing the old generic paths. The updates align with the PR objectives.

Also applies to: 157-157, 165-169, 175-175

---

208-208: ⚠️ Inconsistent domain naming in API links.

Lines 208, 263, and 281 use doc.newapi.pro (without 's') while most other links use docs.newapi.pro (with 's'). This inconsistency could lead to broken links.

Line 208:  doc.newapi.pro/ja/api/google-gemini-chat
Line 263:  doc.newapi.pro/ja/api/google-gemini-chat
Line 281:  doc.newapi.pro/ja/api/google-gemini-chat

Recommend standardizing to docs.newapi.pro domain to align with the routing structure used elsewhere.

Also applies to: 263-263, 281-281

README.fr.md (2)

203-207: ⚠️ Inconsistent domain naming in API links.

Similar to the Japanese version, French README has inconsistent domain usage. Lines 203-207 mix docs.newapi.pro and doc.newapi.pro:

Line 203:  docs.newapi.pro/en/docs/api/ai-model/chat/openai/create-response
Line 204:  docs.newapi.pro/en/docs/api/ai-model/realtime/create-realtime-session
Line 205:  docs.newapi.pro/en/docs/api/ai-model/chat/create-message
Line 206:  doc.newapi.pro/en/api/google-gemini-chat  (missing 's' and wrong path)
Line 207:  docs.newapi.pro/en/docs/api/ai-model/rerank/create-rerank

Line 206 uses both the wrong domain (doc vs docs) and different path structure (/en/api/ instead of /en/docs/api/). This should be corrected to maintain consistency.

Also applies to: 250-254

---

250-254: ✓ French README localization consistent.

The French README correctly updates to /en/docs/ paths (aligned with English per PR), maintaining consistency across deployment, API documentation, and model support sections.

Also applies to: 263-272

README.md (2)

205-209: ⚠️ Inconsistent domain naming in API links (zh version).

Lines 205-209 show the same domain inconsistency pattern:

Line 205:  docs.newapi.pro/zh/docs/api/ai-model/chat/openai/create-response
Line 206:  docs.newapi.pro/zh/docs/api/ai-model/realtime/create-realtime-session
Line 207:  docs.newapi.pro/zh/docs/api/ai-model/chat/create-message
Line 208:  doc.newapi.pro/api/google-gemini-chat  (missing language prefix and 's')
Line 209:  docs.newapi.pro/zh/docs/api/ai-model/rerank/create-rerank

Line 208 is particularly problematic: it uses doc.newapi.pro (not docs) and completely lacks the /zh/docs/ prefix, using the old path structure instead.

---

268-277: ✓ Interface documentation links correctly localized.

The interface section (Chat Completions, Responses, Image, Audio, Video, Embeddings, Rerank, Realtime, Claude Chat, Gemini Chat) properly uses /zh/docs/ prefix throughout.

README.en.md (2)

204-208: ⚠️ Inconsistent domain naming in API links (en version).

Lines 204-208 show the same domain inconsistency appearing across all language versions:

Line 204:  docs.newapi.pro/en/docs/api/ai-model/chat/openai/create-response
Line 205:  docs.newapi.pro/en/docs/api/ai-model/realtime/create-realtime-session
Line 206:  docs.newapi.pro/en/docs/api/ai-model/chat/create-message
Line 207:  doc.newapi.pro/en/api/google-gemini-chat  (missing 's' and inconsistent path)
Line 208:  docs.newapi.pro/en/docs/api/ai-model/rerank/create-rerank

Line 207 uses doc.newapi.pro/en/api/ instead of docs.newapi.pro/en/docs/api/. This pattern appears consistently across all language versions and should be corrected.

---

267-276: ✓ Interface documentation links correctly localized.

The interface section properly uses /en/docs/ prefix throughout (Chat Completions, Responses, Image, Audio, Video, Embeddings, Rerank, Realtime, Claude Chat, Gemini Chat).