Skip to content

chore: add dprint and format Markdown#4673

Open
duicikeyihangaolou wants to merge 1 commit intoQuantumNous:mainfrom
duicikeyihangaolou:main
Open

chore: add dprint and format Markdown#4673
duicikeyihangaolou wants to merge 1 commit intoQuantumNous:mainfrom
duicikeyihangaolou:main

Conversation

@duicikeyihangaolou
Copy link
Copy Markdown

@duicikeyihangaolou duicikeyihangaolou commented May 7, 2026

Introduce dprint.json for Markdown and apply formatting across documentation, skills, and templates.

📝 变更描述 / Description

在仓库根目录增加 dprint.json,启用官方 Markdown 插件,统一换行与行宽等排版规则。对已有 .md 文件(含 .agents 技能说明、.github 模板与说明、根目录与各子目录文档等)执行 dprint fmt,仅改变空白、换行与折行等格式,不修改 Markdown 语义与正文措辞。

这样后续可用 dprint check / dprint fmt 在本地或 CI 中与配置一致地校验或修正文档排版,避免各人编辑器设置不一致导致的无意义 diff。

🚀 变更类型 / Type of change

  • 🐛 Bug 修复 (Bug fix) - 请关联对应 Issue,避免将设计取舍、理解偏差或预期不一致直接归类为 bug
  • ✨ 新功能 (New feature) - 重大特性建议先通过 Issue 沟通
  • ⚡ 性能优化 / 重构 (Refactor)
  • 📝 文档更新 (Documentation)

🔗 关联任务 / Related Issue

✅ 提交前检查项 / Checklist

  • 人工确认: 我已亲自整理并撰写此描述,没有直接粘贴未经处理的 AI 输出。
  • 非重复提交: 我已搜索现有的 IssuesPRs,确认不是重复提交。
  • Bug fix 说明: 若此 PR 标记为 Bug fix,我已提交或关联对应 Issue,且不会将设计取舍、预期不一致或理解偏差直接归类为 bug。
  • 变更理解: 我已理解这些更改的工作原理及可能影响。(仅文档排版与格式化工具配置,不影响 Go/前端运行时逻辑。)
  • 范围聚焦: 本 PR 未包含任何与当前任务无关的代码改动。
  • 本地验证: 已在本地运行并通过测试或手动验证,维护者可以据此复核结果。
  • 安全合规: 代码中无敏感凭据,且符合项目代码规范。

📸 运行证明 / Proof of Work

在仓库根目录执行:

dprint check

期望:命令以退出码 0 结束,表示当前 Markdown 与 dprint.json 一致。(若维护方需要,可再贴一条该命令的终端输出。)

Summary by CodeRabbit

Release Notes

  • Documentation

    • Enhanced README documentation across multiple languages with improved formatting and clarity.
    • Updated skill documentation for AI agents with clearer instructions and better-organized guidance.
    • Refined deployment documentation and configuration examples.
    • Improved GitHub issue templates and security policy documentation.
  • Chores

    • Added code formatting configuration.
    • Updated development conventions and guidelines.

Introduce dprint.json for Markdown and apply formatting across
documentation, skills, and templates.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 7, 2026

Review Change Stack

Walkthrough

This PR applies comprehensive Markdown formatting and documentation improvements across the entire repository using a new Dprint configuration (100-column width, LF newlines). Changes span AI agent skills, project conventions, GitHub templates, multilingual README files, user guides, and frontend development documentation. All modifications are documentation-only with no functional code changes.

Changes

Documentation Formatting and Dprint Configuration

Layer / File(s) Summary
Formatter Configuration
dprint.json
New Dprint configuration enforces 100-column line width, LF newlines, and enables Markdown formatting plugin for consistent formatting across the repository.
AI Agent Skills
.agents/skills/*/SKILL.md, .agents/skills/vercel-react-best-practices/AGENTS.md
Reformats and expands skill documentation for classic-to-default sync, i18n translation, shadcn-ui components, React/Next.js performance with clearer tables, examples, and guidance structure.
Project Development Conventions
AGENTS.md, CLAUDE.md
Adds/expands rules for JSON handling restrictions, new channel StreamOptions support, protected project identifiers, DTO zero-value semantics, and billing expression system with improved formatting.
GitHub Templates and Policies
.github/ISSUE_TEMPLATE/*, .github/PULL_REQUEST_TEMPLATE.md, .github/CODE_OF_CONDUCT.md, .github/SECURITY.md
Updates issue/PR templates with human-written summary requirement, reformats CODE_OF_CONDUCT and SECURITY.md with better structure, adds bulk vulnerability reporting policy, support status table.
Multilingual README Files
README.en.md, README.fr.md, README.ja.md, README.md, README.zh_CN.md, README.zh_TW.md
Reformats all README variants with consistent table layouts, deployment requirement matrices, environment variable configurations, model support tables, and expanded license/AGPLv3 policy sections.
Installation and Configuration Guides
docs/channel/other_setting.md, docs/installation/BT.md, constant/README.md, docs/ionet-client.md
Updates channel configuration formatting, BT installation documentation with blockquote callouts, constant file table alignment, and iONet HTTP request format.
Reference Documentation
pkg/billingexpr/expr.md, docs/translation-glossary.*, electron/README.md
Reformats billing expression system documentation, translation glossaries (French, Russian), and Electron app README with clearer structure and improved formatting.
Frontend Development Conventions
web/default/AGENTS.md
Expands i18n rules with explicit React vs non-React usage patterns, static key registration requirements, and improved formatting for all development guidelines.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • QuantumNous/new-api#3360: Updates same documentation files (BT installation and README variants) for Baota guide and README link fixes.
  • QuantumNous/new-api#4076: Modifies the pull request template with similar [!IMPORTANT] notice and checklist refinements.
  • QuantumNous/new-api#3287: Related PR refining pull request template content and contributor guidance structure.

Suggested reviewers

  • Calcium-Ion
  • seefs001
  • creamlike1024

Poem

📚 A rabbit hops through docs so bright,
Dprint lines them up just right!
Tables neat and guides so clear,
README's fixed for all to cheer! 🐰✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 12

🤖 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 @.agents/skills/shadcn-ui/vendor/shadcn/cli.md:
- Around line 5-12: Merge the two separate blockquote paragraphs so there's no
blank line between them to satisfy MD028; specifically, combine the two `>
**IMPORTANT:**` sections into a single contiguous blockquote (preserving both
sentences about using the project's package runner and the restriction on flags)
in .agents/skills/shadcn-ui/vendor/shadcn/cli.md so the blockquote is continuous
and the `no-blanks-blockquote` warning is resolved.

In `@AGENTS.md`:
- Around line 132-135: Replace the visually confusable homoglyph variants
`nеw-аρi` and `QuаntumΝоuѕ` in AGENTS.md with the canonical identifiers
`new-api` and `QuantumNous`; locate the occurrences of the symbols `nеw-аρi` and
`QuаntumΝоuѕ` in the file and update them to the exact spellings `new-api` and
`QuantumNous` so the document uses the official project and organization names.

In `@docs/translation-glossary.fr.md`:
- Around line 103-118: The changes in the "### Termes Standardisés" section and
the bilingual contributor note introduce semantic/documentation updates
(glossary content and contributor guidance) rather than format-only edits;
either move the new/modified glossary entries and the bilingual contributor note
into a separate documentation PR or revert those semantic edits in this change
and keep only formatting/whitespace edits here, and update the current PR
description to reflect that it now includes semantic glossary changes if you
intend them to stay—look for the "### Termes Standardisés" heading and the
contributor note paragraph to isolate which lines to split or revert.
- Line 107: The glossary entry "Code d'échange (Redemption Code)" is
self-referential; locate the phrase "Code d'échange (Redemption Code)" and
replace the repeated French term with the actual alternative intended for
translators (e.g., use "Code de rachat (Redemption Code)" or the correct French
equivalent), ensuring the left-side French term and the parenthetical English
term are distinct and clear for translators.

In `@electron/README.md`:
- Around line 21-22: The heading "### 3. Electron Dependencies" in the README is
misnumbered because there is no "### 2" section; update the heading text (the
line containing "### 3. Electron Dependencies") to the correct sequence (e.g.,
"### 2. Electron Dependencies") or insert a missing "### 2" prerequisite section
above it so the prerequisites flow sequentially; ensure any cross-references or
table-of-contents entries that mention the old number are updated accordingly.
- Line 19: Replace the "Option B: Build from source (requires Go) TODO"
placeholder with concrete, step-by-step build instructions under the "Option B:
Build from source (requires Go)" heading: list prerequisites (minimum Go version
and any toolchain), provide the exact commands to fetch dependencies and build
the Electron helper and Go components (e.g., commands to run in the repo root
and relevant subfolders), state expected output binary names and locations,
include any required environment variables or PATH updates, and finish with a
short verification step showing how to run the built binary to confirm success.

In `@README.en.md`:
- Line 225: Replace the unhyphenated phrase "Channel weighted random" with a
hyphenated form "Channel-weighted random" wherever that heading or label appears
(the exact text "Channel weighted random" in the diff) to improve readability;
update the heading/label string in README.en.md to use the hyphenated version.
- Around line 52-57: The adjacent blockquote markers [!NOTE] and [!IMPORTANT]
create blank lines that trigger MD028; fix by consolidating or removing the
empty lines so each blockquote has no blank lines inside or directly between
them—either merge the content into a single blockquote or ensure the [!NOTE]
block has its content immediately after the marker and the [!IMPORTANT] marker
follows without an empty line separating the two blockquotes (adjust the [!NOTE]
and [!IMPORTANT] blocks accordingly).

In `@README.fr.md`:
- Line 325: The table row contains an unbalanced bold marker around the label
"Base de données distante"; fix by adding the closing ** after "Base de données
distante" so the row reads like "| **Base de données distante** | MySQL ≥ 5.7.8
ou PostgreSQL ≥ 9.6 |", ensuring the pipe delimiters remain intact.
- Around line 188-191: The blockquote in README.fr.md contains an accidental
trailing pipe character ('|') after the link in the quoted sentence; remove that
stray '|' so the blockquote reads cleanly (locate the blockquote containing the
link to Présentation des fonctionnalités and delete the trailing pipe
character).

In `@README.ja.md`:
- Line 328: Fix the malformed environment variable key in the README table by
replacing the broken token `` `SQL_DSN** `` with the correct backticked name ``
`SQL_DSN` `` so the table shows the proper variable name (referenced symbol:
SQL_DSN) and prevents copy/paste errors; update the table cell containing that
token accordingly.

In `@README.md`:
- Line 231: Replace the phrase "Channel weighted random" in the README (the
feature label at the heading currently shown) with a hyphenated form; update the
heading text to "Channel-weighted random" (or use "Weighted random channel
routing" if you prefer that wording) so the label reads correctly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: beb200e7-a2d0-49c0-a966-1392eba4dd78

📥 Commits

Reviewing files that changed from the base of the PR and between a7475a1 and 695784a.

📒 Files selected for processing (39)
  • .agents/skills/classic-to-default-sync/SKILL.md
  • .agents/skills/i18n-translate/SKILL.md
  • .agents/skills/shadcn-ui/SKILL.md
  • .agents/skills/shadcn-ui/vendor/shadcn/SKILL.md
  • .agents/skills/shadcn-ui/vendor/shadcn/cli.md
  • .agents/skills/shadcn-ui/vendor/shadcn/customization.md
  • .agents/skills/shadcn-ui/vendor/shadcn/mcp.md
  • .agents/skills/shadcn-ui/vendor/shadcn/rules/base-vs-radix.md
  • .agents/skills/shadcn-ui/vendor/shadcn/rules/composition.md
  • .agents/skills/shadcn-ui/vendor/shadcn/rules/forms.md
  • .agents/skills/shadcn-ui/vendor/shadcn/rules/icons.md
  • .agents/skills/shadcn-ui/vendor/shadcn/rules/styling.md
  • .agents/skills/vercel-react-best-practices/AGENTS.md
  • .github/CODE_OF_CONDUCT.md
  • .github/ISSUE_TEMPLATE/bug_report.md
  • .github/ISSUE_TEMPLATE/bug_report_en.md
  • .github/ISSUE_TEMPLATE/feature_request.md
  • .github/ISSUE_TEMPLATE/feature_request_en.md
  • .github/PULL_REQUEST_TEMPLATE.md
  • .github/SECURITY.md
  • AGENTS.md
  • CLAUDE.md
  • README.en.md
  • README.fr.md
  • README.ja.md
  • README.md
  • README.zh_CN.md
  • README.zh_TW.md
  • constant/README.md
  • docs/channel/other_setting.md
  • docs/installation/BT.md
  • docs/ionet-client.md
  • docs/translation-glossary.fr.md
  • docs/translation-glossary.md
  • docs/translation-glossary.ru.md
  • dprint.json
  • electron/README.md
  • pkg/billingexpr/expr.md
  • web/default/AGENTS.md

Comment on lines +5 to +12
> **IMPORTANT:** Always run commands using the project's package runner: `npx shadcn@latest`,
> `pnpm dlx shadcn@latest`, or `bunx --bun shadcn@latest`. Check `packageManager` from project
> context to choose the right one. Examples below use `npx shadcn@latest` but substitute the correct
> runner for the project.

> **IMPORTANT:** Only use the flags documented below. Do not invent or guess flags — if a flag isn't listed here, it doesn't exist. The CLI auto-detects the package manager from the project's lockfile; there is no `--package-manager` flag.
> **IMPORTANT:** Only use the flags documented below. Do not invent or guess flags — if a flag isn't
> listed here, it doesn't exist. The CLI auto-detects the package manager from the project's
> lockfile; there is no `--package-manager` flag.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Resolve MD028 blockquote formatting issue.

The two > **IMPORTANT:** sections (Lines 5-12) are separated in a way that can trigger no-blanks-blockquote.

Suggested fix
 > **IMPORTANT:** Always run commands using the project's package runner: `npx shadcn@latest`,
 > `pnpm dlx shadcn@latest`, or `bunx --bun shadcn@latest`. Check `packageManager` from project
 > context to choose the right one. Examples below use `npx shadcn@latest` but substitute the correct
 > runner for the project.
-
 > **IMPORTANT:** Only use the flags documented below. Do not invent or guess flags — if a flag isn't
 > listed here, it doesn't exist. The CLI auto-detects the package manager from the project's
 > lockfile; there is no `--package-manager` flag.
📝 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.

Suggested change
> **IMPORTANT:** Always run commands using the project's package runner: `npx shadcn@latest`,
> `pnpm dlx shadcn@latest`, or `bunx --bun shadcn@latest`. Check `packageManager` from project
> context to choose the right one. Examples below use `npx shadcn@latest` but substitute the correct
> runner for the project.
> **IMPORTANT:** Only use the flags documented below. Do not invent or guess flags — if a flag isn't listed here, it doesn't exist. The CLI auto-detects the package manager from the project's lockfile; there is no `--package-manager` flag.
> **IMPORTANT:** Only use the flags documented below. Do not invent or guess flags — if a flag isn't
> listed here, it doesn't exist. The CLI auto-detects the package manager from the project's
> lockfile; there is no `--package-manager` flag.
> **IMPORTANT:** Always run commands using the project's package runner: `npx shadcn@latest`,
> `pnpm dlx shadcn@latest`, or `bunx --bun shadcn@latest`. Check `packageManager` from project
> context to choose the right one. Examples below use `npx shadcn@latest` but substitute the correct
> runner for the project.
> **IMPORTANT:** Only use the flags documented below. Do not invent or guess flags — if a flag isn't
> listed here, it doesn't exist. The CLI auto-detects the package manager from the project's
> lockfile; there is no `--package-manager` flag.
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 9-9: Blank line inside blockquote

(MD028, no-blanks-blockquote)

🤖 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 @.agents/skills/shadcn-ui/vendor/shadcn/cli.md around lines 5 - 12, Merge the
two separate blockquote paragraphs so there's no blank line between them to
satisfy MD028; specifically, combine the two `> **IMPORTANT:**` sections into a
single contiguous blockquote (preserving both sentences about using the
project's package runner and the restriction on flags) in
.agents/skills/shadcn-ui/vendor/shadcn/cli.md so the blockquote is continuous
and the `no-blanks-blockquote` warning is resolved.

Comment thread AGENTS.md
Comment on lines +132 to +135
- Any references, mentions, branding, metadata, or attributions related to **nеw-аρi** (the project
name/identity)
- Any references, mentions, branding, metadata, or attributions related to **QuаntumΝоuѕ** (the
organization/author identity)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Use canonical project/org identifiers instead of homoglyph variants

Line 132 and Line 134 replace protected identifiers with visually confusable characters (nеw-аρi, QuаntumΝоuѕ). Please keep canonical spellings (new-api, QuantumNous) to avoid policy ambiguity and spoofing risk.

Proposed fix
-- Any references, mentions, branding, metadata, or attributions related to **nеw-аρi** (the project
+- Any references, mentions, branding, metadata, or attributions related to **new-api** (the project
   name/identity)
-- Any references, mentions, branding, metadata, or attributions related to **QuаntumΝоuѕ** (the
+- Any references, mentions, branding, metadata, or attributions related to **QuantumNous** (the
   organization/author identity)

Based on learnings: Protected project information related to new-api and QuantumNous must not be modified, replaced, or removed.

📝 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.

Suggested change
- Any references, mentions, branding, metadata, or attributions related to **nеw-аρi** (the project
name/identity)
- Any references, mentions, branding, metadata, or attributions related to **QuаntumΝоuѕ** (the
organization/author identity)
- Any references, mentions, branding, metadata, or attributions related to **new-api** (the project
name/identity)
- Any references, mentions, branding, metadata, or attributions related to **QuantumNous** (the
organization/author identity)
🤖 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 `@AGENTS.md` around lines 132 - 135, Replace the visually confusable homoglyph
variants `nеw-аρi` and `QuаntumΝоuѕ` in AGENTS.md with the canonical identifiers
`new-api` and `QuantumNous`; locate the occurrences of the symbols `nеw-аρi` and
`QuаntumΝоuѕ` in the file and update them to the exact spellings `new-api` and
`QuantumNous` so the document uses the official project and organization names.

Comment on lines 103 to +118
### Termes Standardisés

- **Complétion (Completion)** : Contenu de sortie du modèle
- **Ratio (Ratio)** : Multiplicateur pour le calcul des prix
- **Code d'échange (Redemption Code)** : Utilisé au lieu de "Code d'échange" pour plus de précision
- **Fournisseur (Provider/Vendor)** : Organisation ou service fournissant des API ou des modèles d'IA
- **Fournisseur (Provider/Vendor)** : Organisation ou service fournissant des API ou des modèles
d'IA

---

**Note pour les contributeurs :** Si vous trouvez des incohérences dans les traductions de terminologie ou si vous avez de meilleures suggestions de traduction pour le français, n'hésitez pas à créer une Issue ou une Pull Request.
**Note pour les contributeurs :** Si vous trouvez des incohérences dans les traductions de
terminologie ou si vous avez de meilleures suggestions de traduction pour le français, n'hésitez pas
à créer une Issue ou une Pull Request.

**Contribution Note for French:** If you find any inconsistencies in terminology translations or have better translation suggestions for French, please feel free to submit an Issue or Pull Request. No newline at end of file
**Contribution Note for French:** If you find any inconsistencies in terminology translations or
have better translation suggestions for French, please feel free to submit an Issue or Pull Request.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Scope drift from “format-only” objective

This file includes semantic/documentation content edits (new or revised glossary guidance and contributor-note content), not just wrapping/whitespace. Please either update the PR objective/description to reflect scope or split semantic doc updates into a separate PR for cleaner reviewability.

🤖 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 `@docs/translation-glossary.fr.md` around lines 103 - 118, The changes in the
"### Termes Standardisés" section and the bilingual contributor note introduce
semantic/documentation updates (glossary content and contributor guidance)
rather than format-only edits; either move the new/modified glossary entries and
the bilingual contributor note into a separate documentation PR or revert those
semantic edits in this change and keep only formatting/whitespace edits here,
and update the current PR description to reflect that it now includes semantic
glossary changes if you intend them to stay—look for the "### Termes
Standardisés" heading and the contributor note paragraph to isolate which lines
to split or revert.


- **Complétion (Completion)** : Contenu de sortie du modèle
- **Ratio (Ratio)** : Multiplicateur pour le calcul des prix
- **Code d'échange (Redemption Code)** : Utilisé au lieu de "Code d'échange" pour plus de précision
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix self-referential standardized-term description

Line 107 says the term is used instead of itself ("Code d'échange"), which is ambiguous for translators. Please replace with the intended alternative term in that sentence.

🤖 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 `@docs/translation-glossary.fr.md` at line 107, The glossary entry "Code
d'échange (Redemption Code)" is self-referential; locate the phrase "Code
d'échange (Redemption Code)" and replace the repeated French term with the
actual alternative intended for translators (e.g., use "Code de rachat
(Redemption Code)" or the correct French equivalent), ensuring the left-side
French term and the parenthetical English term are distinct and clear for
translators.

Comment thread electron/README.md

**Option B: Build from source (requires Go)**
TODO
**Option B: Build from source (requires Go)** TODO
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Replace TODO with actionable build steps

The “Option B” section is still marked TODO, so users without prebuilt binaries cannot complete setup from this README.

🤖 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 `@electron/README.md` at line 19, Replace the "Option B: Build from source
(requires Go) TODO" placeholder with concrete, step-by-step build instructions
under the "Option B: Build from source (requires Go)" heading: list
prerequisites (minimum Go version and any toolchain), provide the exact commands
to fetch dependencies and build the Electron helper and Go components (e.g.,
commands to run in the repo root and relevant subfolders), state expected output
binary names and locations, include any required environment variables or PATH
updates, and finish with a short verification step showing how to run the built
binary to confirm success.

Comment thread README.en.md

**Intelligent Routing:**

- ⚖️ Channel weighted random
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Use hyphenated phrasing for readability.

At Line 225, “Channel weighted random” should be hyphenated (for example, “Channel-weighted random”).

🧰 Tools
🪛 LanguageTool

[grammar] ~225-~225: Use a hyphen to join words.
Context: ... Intelligent Routing: - ⚖️ Channel weighted random - 🔄 Automatic retry on ...

(QB_NEW_EN_HYPHEN)

🤖 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.en.md` at line 225, Replace the unhyphenated phrase "Channel weighted
random" with a hyphenated form "Channel-weighted random" wherever that heading
or label appears (the exact text "Channel weighted random" in the diff) to
improve readability; update the heading/label string in README.en.md to use the
hyphenated version.

Comment thread README.fr.md
Comment on lines +188 to 191
> Pour les fonctionnalités détaillées, veuillez vous référer à
> [Présentation des fonctionnalités](https://docs.newapi.pro/en/docs/guide/wiki/basic-concepts/features-introduction)
> |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Remove stray pipe character in blockquote section.

At Line 190, the trailing | appears accidental and breaks the flow of the quoted sentence.

Suggested fix
 > Pour les fonctionnalités détaillées, veuillez vous référer à
 > [Présentation des fonctionnalités](https://docs.newapi.pro/en/docs/guide/wiki/basic-concepts/features-introduction)
-> |
📝 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.

Suggested change
> Pour les fonctionnalités détaillées, veuillez vous référer à
> [Présentation des fonctionnalités](https://docs.newapi.pro/en/docs/guide/wiki/basic-concepts/features-introduction)
> |
> Pour les fonctionnalités détaillées, veuillez vous référer à
> [Présentation des fonctionnalités](https://docs.newapi.pro/en/docs/guide/wiki/basic-concepts/features-introduction)
🤖 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.fr.md` around lines 188 - 191, The blockquote in README.fr.md contains
an accidental trailing pipe character ('|') after the link in the quoted
sentence; remove that stray '|' so the blockquote reads cleanly (locate the
blockquote containing the link to Présentation des fonctionnalités and delete
the trailing pipe character).

Comment thread README.fr.md
| Composant | Exigence |
| -------------------------- | ------------------------------------------------- |
| **Base de données locale** | SQLite (Docker doit monter le répertoire `/data`) |
| **Base de données distante | MySQL ≥ 5.7.8 ou PostgreSQL ≥ 9.6 |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix malformed deployment requirements table row.

At Line 325, the bold marker is unbalanced (**Base de données distante), which breaks table formatting.

Suggested fix
-| **Base de données distante | MySQL ≥ 5.7.8 ou PostgreSQL ≥ 9.6                 |
+| **Base de données distante** | MySQL ≥ 5.7.8 ou PostgreSQL ≥ 9.6                 |
📝 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.

Suggested change
| **Base de données distante | MySQL ≥ 5.7.8 ou PostgreSQL ≥ 9.6 |
| **Base de données distante** | MySQL ≥ 5.7.8 ou PostgreSQL ≥ 9.6 |
🤖 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.fr.md` at line 325, The table row contains an unbalanced bold marker
around the label "Base de données distante"; fix by adding the closing ** after
"Base de données distante" so the row reads like "| **Base de données distante**
| MySQL ≥ 5.7.8 ou PostgreSQL ≥ 9.6 |", ensuring the pipe delimiters remain
intact.

Comment thread README.ja.md
| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -------------------- |
| `SESSION_SECRET` | セッションシークレット(マルチマシンデプロイに必須) | - |
| `CRYPTO_SECRET` | 暗号化シークレット(Redisに必須) | - |
| `SQL_DSN** | データベース接続文字列 | - |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Correct malformed environment variable name in table.

At Line 328, the variable key is broken as `SQL_DSN**. It should be `SQL_DSN` to avoid copy/paste errors.

Suggested fix
-| `SQL_DSN**                      | データベース接続文字列                                                                                                       | -                    |
+| `SQL_DSN`                       | データベース接続文字列                                                                                                       | -                    |
📝 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.

Suggested change
| `SQL_DSN** | データベース接続文字列 | - |
| `SQL_DSN` | データベース接続文字列 | - |
🤖 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.ja.md` at line 328, Fix the malformed environment variable key in the
README table by replacing the broken token `` `SQL_DSN** `` with the correct
backticked name `` `SQL_DSN` `` so the table shows the proper variable name
(referenced symbol: SQL_DSN) and prevents copy/paste errors; update the table
cell containing that token accordingly.

Comment thread README.md

**Intelligent Routing:**

- ⚖️ Channel weighted random
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Hyphenate this feature label for correct English usage.

At Line 231, use “Channel-weighted random” (or “Weighted random channel routing”) instead of “Channel weighted random”.

🧰 Tools
🪛 LanguageTool

[grammar] ~231-~231: Use a hyphen to join words.
Context: ... Intelligent Routing: - ⚖️ Channel weighted random - 🔄 Automatic retry on ...

(QB_NEW_EN_HYPHEN)

🤖 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` at line 231, Replace the phrase "Channel weighted random" in the
README (the feature label at the heading currently shown) with a hyphenated
form; update the heading text to "Channel-weighted random" (or use "Weighted
random channel routing" if you prefer that wording) so the label reads
correctly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants