Update README.md - #5008
Closed
AIPDD-work wants to merge 1 commit into
Closed
Conversation
Contributor
WalkthroughREADME.md is comprehensively rewritten to localize the project documentation from English to Chinese and rebrand it as AIPDD-new-api. The title, navigation, installation guidance, feature descriptions, deployment instructions, and footer are all translated and updated to reflect the new project branding. ChangesREADME Chinese Localization and Rebranding
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 159-160: Update the inconsistent documentation domains by
replacing any occurrences of "doc.newapi.pro" with "docs.newapi.pro" in the
README entries that reference Google Gemini and the Rerank 模型 (the URLs
"https://doc.newapi.pro/api/google-gemini-chat" and
"https://docs.newapi.pro/zh/docs/api/ai-model/rerank/create-rerank" and the
other instances noted around the same section); ensure the bullet lines
containing "Google Gemini" and "Rerank 模型" (and the other two occurrences called
out) use the canonical "https://docs.newapi.pro" host so links across the README
remain consistent.
- Around line 62-63: The README shows inconsistent repo names: the git clone
uses "aipdd-new-api" while the subsequent cd uses "new-api", causing copy/paste
failures; update the commands so they reference the same directory name in both
places (either change the clone URL to end with "new-api" or change the cd
commands to "cd aipdd-new-api") and make the same fix for the duplicate
occurrence later in the file (the second block around lines 285–287) so both
clone and cd consistently point to the identical repository directory.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+62
to
63
| git clone https://github.com/liujh0729-jpg/aipdd-new-api.git | ||
| cd new-api |
Contributor
There was a problem hiding this comment.
Unify repository clone path and cd command to avoid setup failure (Line 62, Line 63, Line 285, Line 286).
The two install paths point to different repos, and one section clones aipdd-new-api but then enters new-api. This can break copy-paste onboarding.
Suggested doc fix
- git clone https://github.com/liujh0729-jpg/aipdd-new-api.git
- cd new-api
+ git clone https://github.com/liujh0729-jpg/aipdd-new-api.git
+ cd aipdd-new-api- git clone https://github.com/QuantumNous/new-api.git
- cd new-api
+ git clone https://github.com/liujh0729-jpg/aipdd-new-api.git
+ cd aipdd-new-apiAlso applies to: 285-287
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 62 - 63, The README shows inconsistent repo names:
the git clone uses "aipdd-new-api" while the subsequent cd uses "new-api",
causing copy/paste failures; update the commands so they reference the same
directory name in both places (either change the clone URL to end with "new-api"
or change the cd commands to "cd aipdd-new-api") and make the same fix for the
duplicate occurrence later in the file (the second block around lines 285–287)
so both clone and cd consistently point to the identical repository directory.
Comment on lines
+159
to
+160
| - ⚡ [Google Gemini](https://doc.newapi.pro/api/google-gemini-chat) | ||
| - 🔄 [Rerank 模型](https://docs.newapi.pro/zh/docs/api/ai-model/rerank/create-rerank)（Cohere、Jina） |
Contributor
There was a problem hiding this comment.
Normalize documentation domains to prevent stale/broken links (Line 159, Line 209, Line 210).
These entries use doc.newapi.pro while the rest of the README consistently uses docs.newapi.pro.
Suggested doc fix
- - ⚡ [Google Gemini](https://doc.newapi.pro/api/google-gemini-chat)
+ - ⚡ [Google Gemini](https://docs.newapi.pro/zh/docs/api/ai-model/chat/gemini/geminirelayv1beta)
- | 🎨 Midjourney-Proxy | [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy) | [文档](https://doc.newapi.pro/api/midjourney-proxy-image) |
+ | 🎨 Midjourney-Proxy | [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy) | [文档](https://docs.newapi.pro/zh/docs/api/ai-model/images/midjourney/) |
- | 🎵 Suno-API | [Suno API](https://github.com/Suno-API/Suno-API) | [文档](https://doc.newapi.pro/api/suno-music) |
+ | 🎵 Suno-API | [Suno API](https://github.com/Suno-API/Suno-API) | [文档](https://docs.newapi.pro/zh/docs/api/) |Also applies to: 209-210
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 159 - 160, Update the inconsistent documentation
domains by replacing any occurrences of "doc.newapi.pro" with "docs.newapi.pro"
in the README entries that reference Google Gemini and the Rerank 模型 (the URLs
"https://doc.newapi.pro/api/google-gemini-chat" and
"https://docs.newapi.pro/zh/docs/api/ai-model/rerank/create-rerank" and the
other instances noted around the same section); ensure the bullet lines
containing "Google Gemini" and "Rerank 模型" (and the other two occurrences called
out) use the canonical "https://docs.newapi.pro" host so links across the README
remain consistent.
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
2 participants
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.
Important
📝 变更描述 / Description
(简述：做了什么？为什么这样改能生效？请基于你对代码逻辑的理解来写，避免粘贴未经整理的内容)
🚀 变更类型 / Type of change
🔗 关联任务 / Related Issue
✅ 提交前检查项 / Checklist
Bug fix，我已提交或关联对应 Issue，且不会将设计取舍、预期不一致或理解偏差直接归类为 bug。📸 运行证明 / Proof of Work
(请在此粘贴截图、关键日志或测试报告，以证明变更生效)
Summary by CodeRabbit