🤝 docs(README): Introduction to New Partners - #1627
Conversation
WalkthroughDocumentation updates: both READMEs add a partners/sponsors section and change STREAMING_TIMEOUT default from 120s to 300s; the web API doc updates product naming to “New API,” adjusts headings/formatting, and adds a header row to a user-operations table. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (12)
docs/api/web_api.md (5)
64-79: Add blank lines around tables and normalize table headers for consistency
- Markdown lint MD058: tables should be surrounded by blank lines. Add a blank line before/after the table under 5.2.
- Consider enforcing the same 4-column header across all “用户模块” subsections to improve scanability.
### 5.2 用户自身操作 (需登录) + | 方法 | 路径 | 鉴权 | 说明 | |------|------|------|------| | GET | /api/user/self/groups | 用户 | 获取自己所在分组 | @@ | POST | /api/user/aff_transfer | 用户 | 推广额度转账 | | PUT | /api/user/setting | 用户 | 更新用户设置 | +
31-33: Clarify “可匿名/用户” 鉴权标签 or align to legendThe legend defines 公开、用户、管理员、Root, but row “/api/pricing” uses “可匿名/用户”. Either:
- Change to “公开” if truly public, or
- Extend the legend to define “可匿名” and how it differs from 公开.
172-174: Fix table formatting in Section 13Section 13 currently shows a single row without a header or separators. For consistency with other sections, add a header row and fence lines.
## 13. 分组 -| GET | /api/group/ | 管理员 | 获取全部分组列表 | +| 方法 | 路径 | 鉴权 | 说明 | +|------|------|------|------| +| GET | /api/group/ | 管理员 | 获取全部分组列表 |
15-23: Surround all tables with blank lines to satisfy MD058 and improve readabilityMultiple sections place a table immediately after a heading with no blank line. Insert one blank line before and after each table. This will also make GitHub rendering and external tooling more robust.
Also applies to: 24-33, 35-40, 42-53, 55-63, 80-90, 92-98, 100-104, 106-131, 133-142, 144-153, 155-165, 167-171, 175-180, 182-186, 188-194
197-197: Update the “更新日期” if this PR modifies contentDoc footer still shows 2025.07.17. If we’re publishing these edits now, update to 2025.08.21 (or remove the footer if dates are tracked via VCS/CI).
README.md (3)
43-46: Prefer Markdown headings over raw HTML for ToC and consistencySwitch
to Markdown to keep consistent styling and auto-generated ToC behavior.
-<h2>🤝 我们信任的合作伙伴</h2> +## 🤝 我们信任的合作伙伴
47-61: Optional: Lazy-load large logo imagesAdding loading="lazy" to
reduces initial page weight for the partner grid.
- src="./docs/images/cherry-studio.png" alt="Cherry Studio" height="120" + src="./docs/images/cherry-studio.png" alt="Cherry Studio" height="120" loading="lazy"Repeat for the other four images in this block.
138-139: Normalize env var key formattingOther bullets list the variable name only; this one embeds a value. Suggest making it consistent.
-- `ERROR_LOG_ENABLED=true`: 是否记录并显示错误日志，默认`false` +- `ERROR_LOG_ENABLED`: 是否记录并显示错误日志，默认 `false`README.en.md (4)
43-46: Prefer Markdown headings over raw HTML for ToC and consistencyUse Markdown heading instead of
.
-<h2>🤝 Trusted Partners</h2> +## 🤝 Trusted Partners
45-45: Minor wording polish“In no particular order” reads more naturally.
-<p align="center"><strong>No particular order</strong></p> +<p align="center"><strong>In no particular order</strong></p>
47-61: Optional: Lazy-load large images in the partners blockAdd loading="lazy" to reduce initial page load.
- src="./docs/images/cherry-studio.png" alt="Cherry Studio" height="120" + src="./docs/images/cherry-studio.png" alt="Cherry Studio" height="120" loading="lazy"Repeat for the remaining four images.
138-139: Normalize env var key formattingKeep only the key name for consistency with the rest.
-- `ERROR_LOG_ENABLED=true`: Whether to record and display error logs, default is `false` +- `ERROR_LOG_ENABLED`: Whether to record and display error logs, default is `false`
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (5)
docs/images/aliyun.pngis excluded by!**/*.pngdocs/images/cherry-studio.pngis excluded by!**/*.pngdocs/images/io-net.pngis excluded by!**/*.pngdocs/images/pku.pngis excluded by!**/*.pngdocs/images/ucloud.pngis excluded by!**/*.png
📒 Files selected for processing (3)
README.en.md(2 hunks)README.md(2 hunks)docs/api/web_api.md(3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.en.md
56-56: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
🔇 Additional comments (3)
docs/api/web_api.md (1)
1-3: Branding rename to “New API” looks goodConsistent rename in title and intro. No functional impact.
README.md (1)
47-61: Verify asset availabilityEnsure the five local images exist at the paths used: docs/images/{cherry-studio.png,pku.png,ucloud.png,aliyun.png,io-net.png}. Broken logos in the README are noisy.
README.en.md (1)
47-61: Verify assets exist at referenced pathsEnsure the five local images under docs/images are present to avoid broken images on GitHub and package registries.
| <h2>🤝 Trusted Partners</h2> | ||
| <p id="premium-sponsors"> </p> | ||
| <p align="center"><strong>No particular order</strong></p> | ||
| <p align="center"> | ||
| <a href="https://www.cherry-ai.com/" target=_blank><img | ||
| src="./docs/images/cherry-studio.png" alt="Cherry Studio" height="120" | ||
| /></a> | ||
| <a href="https://bda.pku.edu.cn/" target=_blank><img | ||
| src="./docs/images/pku.png" alt="Peking University" height="120" | ||
| /></a> | ||
| <a href="https://www.compshare.cn/?ytag=GPU_yy_gh_newapi" target=_blank><img | ||
| src="./docs/images/ucloud.png" alt="UCloud" height="120" | ||
| /></a> | ||
| <a href="https://www.aliyun.com/" target=_blank><img | ||
| src="./docs/images/aliyun.png" alt="Alibaba Cloud" height="120" | ||
| /></a> | ||
| <a href="https://io.net/" target=_blank><img | ||
| src="./docs/images/io-net.png" alt="IO.NET" height="120" | ||
| /></a> | ||
| </p> | ||
| <p> </p> | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Harden external links opened in new tabs
Add rel="noopener noreferrer" and quote the target attribute.
- <a href="https://www.cherry-ai.com/" target=_blank><img
+ <a href="https://www.cherry-ai.com/" target="_blank" rel="noopener noreferrer"><img
@@
- <a href="https://bda.pku.edu.cn/" target=_blank><img
+ <a href="https://bda.pku.edu.cn/" target="_blank" rel="noopener noreferrer"><img
@@
- <a href="https://www.compshare.cn/?ytag=GPU_yy_gh_newapi" target=_blank><img
+ <a href="https://www.compshare.cn/?ytag=GPU_yy_gh_newapi" target="_blank" rel="noopener noreferrer"><img
@@
- <a href="https://www.aliyun.com/" target=_blank><img
+ <a href="https://www.aliyun.com/" target="_blank" rel="noopener noreferrer"><img
@@
- <a href="https://io.net/" target=_blank><img
+ <a href="https://io.net/" target="_blank" rel="noopener noreferrer"><img📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <h2>🤝 Trusted Partners</h2> | |
| <p id="premium-sponsors"> </p> | |
| <p align="center"><strong>No particular order</strong></p> | |
| <p align="center"> | |
| <a href="https://www.cherry-ai.com/" target=_blank><img | |
| src="./docs/images/cherry-studio.png" alt="Cherry Studio" height="120" | |
| /></a> | |
| <a href="https://bda.pku.edu.cn/" target=_blank><img | |
| src="./docs/images/pku.png" alt="Peking University" height="120" | |
| /></a> | |
| <a href="https://www.compshare.cn/?ytag=GPU_yy_gh_newapi" target=_blank><img | |
| src="./docs/images/ucloud.png" alt="UCloud" height="120" | |
| /></a> | |
| <a href="https://www.aliyun.com/" target=_blank><img | |
| src="./docs/images/aliyun.png" alt="Alibaba Cloud" height="120" | |
| /></a> | |
| <a href="https://io.net/" target=_blank><img | |
| src="./docs/images/io-net.png" alt="IO.NET" height="120" | |
| /></a> | |
| </p> | |
| <p> </p> | |
| <h2>🤝 Trusted Partners</h2> | |
| <p id="premium-sponsors"> </p> | |
| <p align="center"><strong>No particular order</strong></p> | |
| <p align="center"> | |
| <a href="https://www.cherry-ai.com/" target="_blank" rel="noopener noreferrer"><img | |
| src="./docs/images/cherry-studio.png" alt="Cherry Studio" height="120" | |
| /></a> | |
| <a href="https://bda.pku.edu.cn/" target="_blank" rel="noopener noreferrer"><img | |
| src="./docs/images/pku.png" alt="Peking University" height="120" | |
| /></a> | |
| <a href="https://www.compshare.cn/?ytag=GPU_yy_gh_newapi" target="_blank" rel="noopener noreferrer"><img | |
| src="./docs/images/ucloud.png" alt="UCloud" height="120" | |
| /></a> | |
| <a href="https://www.aliyun.com/" target="_blank" rel="noopener noreferrer"><img | |
| src="./docs/images/aliyun.png" alt="Alibaba Cloud" height="120" | |
| /></a> | |
| <a href="https://io.net/" target="_blank" rel="noopener noreferrer"><img | |
| src="./docs/images/io-net.png" alt="IO.NET" height="120" | |
| /></a> | |
| </p> | |
| <p> </p> |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
56-56: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
🤖 Prompt for AI Agents
In README.en.md around lines 43 to 64, the external anchor tags use unquoted
target attributes and open in new tabs without rel protections; update each <a>
tag to use target="_blank" (quoted) and add rel="noopener noreferrer" to each
external link so they are hardened against reverse tabnabbing and comply with
best practices.
|
|
||
| - `GENERATE_DEFAULT_TOKEN`: Whether to generate initial tokens for newly registered users, default is `false` | ||
| - `STREAMING_TIMEOUT`: Streaming response timeout, default is 120 seconds | ||
| - `STREAMING_TIMEOUT`: Streaming response timeout, default is 300 seconds |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
STREAMING_TIMEOUT default to 300s — ensure implementation matches
Mirror of the zh-CN README note: verify code/config defaults and other docs.
🏁 Script executed:
#!/bin/bash
# Same audit as in README.md; kept separate in case this file lives in a submodule/website.
set -euo pipefail
rg -nP --hidden --no-ignore 'STREAMING_TIMEOUT\s*[:=]\s*["'\'']?\d+["'\'']?' -S -g '!**/node_modules/**' -g '!**/dist/**' -g '!**/build/**'
rg -nP --hidden --no-ignore 'STREAMING_TIMEOUT[^\\n]{0,80}120' -S -g '!**/node_modules/**' -g '!**/dist/**' -g '!**/build/**'Length of output: 657
STREAMING_TIMEOUT default mismatch — documentation update required
The codebase defines the default STREAMING_TIMEOUT as 120 seconds (see common/init.go:104), and both the example in docker-compose.yml and .env.example comment likewise reference 120 seconds. Please update the English README (and mirror the change in the Chinese version) so that line 125 reads:
- `STREAMING_TIMEOUT`: Streaming response timeout, default is 300 seconds
+ `STREAMING_TIMEOUT`: Streaming response timeout, default is 120 seconds🤖 Prompt for AI Agents
In README.en.md around line 125, the documented default for STREAMING_TIMEOUT is
incorrect (says 300 seconds); update that line to state the default is 120
seconds (replace "300 seconds" with "120 seconds"); also apply the same change
to the Chinese README (README.zh.md or equivalent) so both docs match the code
and examples.
| <h2>🤝 我们信任的合作伙伴</h2> | ||
| <p id="premium-sponsors"> </p> | ||
| <p align="center"><strong>排名不分先后</strong></p> | ||
| <p align="center"> | ||
| <a href="https://www.cherry-ai.com/" target=_blank><img | ||
| src="./docs/images/cherry-studio.png" alt="Cherry Studio" height="120" | ||
| /></a> | ||
| <a href="https://bda.pku.edu.cn/" target=_blank><img | ||
| src="./docs/images/pku.png" alt="北京大学" height="120" | ||
| /></a> | ||
| <a href="https://www.compshare.cn/?ytag=GPU_yy_gh_newapi" target=_blank><img | ||
| src="./docs/images/ucloud.png" alt="UCloud 优刻得" height="120" | ||
| /></a> | ||
| <a href="https://www.aliyun.com/" target=_blank><img | ||
| src="./docs/images/aliyun.png" alt="阿里云" height="120" | ||
| /></a> | ||
| <a href="https://io.net/" target=_blank><img | ||
| src="./docs/images/io-net.png" alt="IO.NET" height="120" | ||
| /></a> | ||
| </p> | ||
| <p> </p> | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Harden external links opened in new tabs
Add rel="noopener noreferrer" and quote the target attribute to prevent reverse tabnabbing and improve HTML validity.
- <a href="https://www.cherry-ai.com/" target=_blank><img
+ <a href="https://www.cherry-ai.com/" target="_blank" rel="noopener noreferrer"><img
@@
- <a href="https://bda.pku.edu.cn/" target=_blank><img
+ <a href="https://bda.pku.edu.cn/" target="_blank" rel="noopener noreferrer"><img
@@
- <a href="https://www.compshare.cn/?ytag=GPU_yy_gh_newapi" target=_blank><img
+ <a href="https://www.compshare.cn/?ytag=GPU_yy_gh_newapi" target="_blank" rel="noopener noreferrer"><img
@@
- <a href="https://www.aliyun.com/" target=_blank><img
+ <a href="https://www.aliyun.com/" target="_blank" rel="noopener noreferrer"><img
@@
- <a href="https://io.net/" target=_blank><img
+ <a href="https://io.net/" target="_blank" rel="noopener noreferrer"><img📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <h2>🤝 我们信任的合作伙伴</h2> | |
| <p id="premium-sponsors"> </p> | |
| <p align="center"><strong>排名不分先后</strong></p> | |
| <p align="center"> | |
| <a href="https://www.cherry-ai.com/" target=_blank><img | |
| src="./docs/images/cherry-studio.png" alt="Cherry Studio" height="120" | |
| /></a> | |
| <a href="https://bda.pku.edu.cn/" target=_blank><img | |
| src="./docs/images/pku.png" alt="北京大学" height="120" | |
| /></a> | |
| <a href="https://www.compshare.cn/?ytag=GPU_yy_gh_newapi" target=_blank><img | |
| src="./docs/images/ucloud.png" alt="UCloud 优刻得" height="120" | |
| /></a> | |
| <a href="https://www.aliyun.com/" target=_blank><img | |
| src="./docs/images/aliyun.png" alt="阿里云" height="120" | |
| /></a> | |
| <a href="https://io.net/" target=_blank><img | |
| src="./docs/images/io-net.png" alt="IO.NET" height="120" | |
| /></a> | |
| </p> | |
| <p> </p> | |
| <h2>🤝 我们信任的合作伙伴</h2> | |
| <p id="premium-sponsors"> </p> | |
| <p align="center"><strong>排名不分先后</strong></p> | |
| <p align="center"> | |
| <a href="https://www.cherry-ai.com/" target="_blank" rel="noopener noreferrer"><img | |
| src="./docs/images/cherry-studio.png" alt="Cherry Studio" height="120" | |
| /></a> | |
| <a href="https://bda.pku.edu.cn/" target="_blank" rel="noopener noreferrer"><img | |
| src="./docs/images/pku.png" alt="北京大学" height="120" | |
| /></a> | |
| <a href="https://www.compshare.cn/?ytag=GPU_yy_gh_newapi" target="_blank" rel="noopener noreferrer"><img | |
| src="./docs/images/ucloud.png" alt="UCloud 优刻得" height="120" | |
| /></a> | |
| <a href="https://www.aliyun.com/" target="_blank" rel="noopener noreferrer"><img | |
| src="./docs/images/aliyun.png" alt="阿里云" height="120" | |
| /></a> | |
| <a href="https://io.net/" target="_blank" rel="noopener noreferrer"><img | |
| src="./docs/images/io-net.png" alt="IO.NET" height="120" | |
| /></a> | |
| </p> | |
| <p> </p> |
🤖 Prompt for AI Agents
In README.md around lines 43 to 64, the anchor tags open external links in new
tabs using unquoted target attributes and lack rel protections; update each <a>
tag in this block to quote the target attribute (target="_blank") and add
rel="noopener noreferrer" to prevent reverse tabnabbing and satisfy HTML
validity; ensure all anchors in the shown partner/logo section are updated
consistently.
|
|
||
| - `GENERATE_DEFAULT_TOKEN`：是否为新注册用户生成初始令牌，默认为 `false` | ||
| - `STREAMING_TIMEOUT`：流式回复超时时间，默认120秒 | ||
| - `STREAMING_TIMEOUT`：流式回复超时时间，默认300秒 |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
STREAMING_TIMEOUT default changed to 300s — verify implementation and other docs
Nice doc update. Please confirm the actual default in code/config matches 300s (env loaders, Helm charts, Docker examples, .env templates). If not, either update code or revert docs.
🏁 Script executed:
#!/bin/bash
# Verify STREAMING_TIMEOUT defaults and docs consistency.
set -euo pipefail
echo "Search occurrences of STREAMING_TIMEOUT with numeric defaults:"
rg -nP --hidden --no-ignore 'STREAMING_TIMEOUT\s*[:=]\s*["'\'']?\d+["'\'']?' -S -g '!**/node_modules/**' -g '!**/dist/**' -g '!**/build/**'
echo
echo "Check for any lingering 120-second mentions tied to STREAMING_TIMEOUT:"
rg -nP --hidden --no-ignore 'STREAMING_TIMEOUT[^\\n]{0,80}120' -S -g '!**/node_modules/**' -g '!**/dist/**' -g '!**/build/**'
echo
echo "Common config files that might carry defaults:"
fd -H -t f -i '(.env|.env.example|docker-compose.*|values.*\.ya?ml|Chart\.ya?ml|kustomization\.ya?ml|config\.(ya?ml|json)|settings\.(ya?ml|json))' \
-E node_modules -E dist -E build | sed -n '1,200p'
echo
echo "Show lines around STREAMING_TIMEOUT in config-like files:"
fd -H -t f -i '(.env|.env.example|docker-compose.*|values.*\.ya?ml|Chart\.ya?ml|kustomization\.ya?ml|config\.(ya?ml|json)|settings\.(ya?ml|json))' \
-E node_modules -E dist -E build \
| xargs -r rg -nP 'STREAMING_TIMEOUT.*' -S -n -C2Length of output: 2282
Mismatch between documented and actual STREAMING_TIMEOUT default
The documentation now states a 300-second default, but the code and example configurations still use 120 seconds. Please align them by updating the implementation and examples (or revert the docs if 120s is intended).
Files requiring updates:
common/init.go(around line 104):- constant.StreamingTimeout = GetEnvOrDefault("STREAMING_TIMEOUT", 120) + constant.StreamingTimeout = GetEnvOrDefault("STREAMING_TIMEOUT", 300)
.env.example(line 50):- # STREAMING_TIMEOUT=120 + # STREAMING_TIMEOUT=300
docker-compose.yml(line 19):- # - STREAMING_TIMEOUT=120 # 流模式无响应超时时间，单位秒，默认120秒，如果出现空补全可以尝试改为更大值 + # - STREAMING_TIMEOUT=300 # 流模式无响应超时时间，单位秒，默认300秒，如果出现空补全可以尝试改为更大值
🤖 Prompt for AI Agents
In README.md line 125 and in the codebase (common/init.go around line 104,
.env.example line 50, docker-compose.yml line 19) the documented
STREAMING_TIMEOUT (300s) mismatches actual defaults (120s); align them by
updating the implementation and examples to 300s: change the default/constant in
common/init.go to 300 (or read from env with fallback 300), set
STREAMING_TIMEOUT=300 in .env.example, and set the environment variable value to
300 in docker-compose.yml; also search the repo for other STREAMING_TIMEOUT
occurrences and update any remaining examples or defaults to 300 (or revert
README to 120 if 120s is the intended value).
…ner-intro 🤝 docs(README): Introduction to New Partners
2 participants
Summary by CodeRabbit