Skip to content

docs(readme): reorder sections and fix stale claims - #2422

Merged
zerob13 merged 1 commit into
devfrom
docs/readme-refine
Oct 10, 2026
Merged

zerob13 merged 1 commit into
devfrom
docs/readme-refine

Conversation

@zerob13

@zerob13 zerob13 commented Oct 10, 2026 •

Copy link
Copy Markdown
Collaborator

What changed

Same treatment applied to README.md, README.zh.md, and README.jp.md:

  • Reading order: Quick Start (download/install/configure/start) moved from below the provider grid to right after Why Choose DeepChat, so install instructions are no longer buried under ~200 lines of provider logos. The TOC is reordered to match; heading parity across the three languages is 25/25/25.
  • Ask DeepWiki badge removed from all three files.
  • Sponsor section unchanged — same position (after the language switcher, before the TOC) and same order (OpenModel → PackyCode).
  • Stale claims fixed (checked against the code):
    • Built-in Skills list aligned with resources/skills/: algorithmic art (was "generative art"), DeepChat CLI and memory management added, Web Artifacts removed (retired per docs/architecture/remove-built-in-artifacts/spec.md).
    • JP: removed the "built-in Node.js runtime" claim (packaged apps resolve Node through Settings → Toolchains).
    • EN BoSearch and JP 博查搜索 → Bocha Search (matches en-US i18n naming).
    • The Compatible with any model provider… heading previously had no content; added one sentence.
  • Dead links fixed: translation link pointed to tree/main/locales (directory does not exist) → src/renderer/src/i18n; ZH contribution links now point to CONTRIBUTING.zh.md.
  • Docs pointer dedup: docs/README.md was linked twice in EN and zero times in ZH/JA, framed as a user guide although it is a maintainer index; consolidated into one accurate link under Development Guide.

Structure (before → after)

BEFORE                              AFTER
Sponsor                             Sponsor            (unchanged)
TOC                                 TOC                (reordered)
Project Introduction                Project Introduction
Why Choose                          Why Choose
Main Features                       Quick Start        (moved up)
Tape/Skills/ACP/Remote              Main Features
Supported Model Providers           Tape/Skills/ACP/Remote
Use Cases                           Supported Model Providers
Quick Start  (buried)               Use Cases
Development Guide                   Development Guide
Community/.../License               Community/.../License

Verification

  • All TOC anchors resolve; every relative link and asset in the three files exists (script check).
  • No test or CI check pins README content (test/, scripts/, .github/ grepped).
  • README files are excluded from oxfmt (ignorePatterns), so no format impact. Docs-only change, no source code touched.

Summary by CodeRabbit

  • Documentation
    • Updated the English, Japanese, and Chinese README guides with clearer quick-start instructions and links to developer documentation.
    • Added information about custom providers compatible with OpenAI, Gemini, or Anthropic API formats.
    • Updated the listed built-in skills and contribution links.

- Move Quick Start above Main Features so install steps are not buried
- Remove the Ask DeepWiki badge from all three READMEs
- Keep sponsor position and order unchanged
- Fix stale Skills list, JP Node runtime claim, Bocha naming, and dead links
@coderabbitai

coderabbitai Bot commented Oct 10, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: a89122be-676a-4be0-a99f-652eecba7437

📥 Commits

Reviewing files that changed from the base of the PR and between bfa6d76 and bdd9248.


📒 Files selected for processing (3)
  • README.jp.md
  • README.md
  • README.zh.md

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.



📝 Walkthrough

Walkthrough

The English, Japanese, and Chinese READMEs move and expand Quick Start instructions. They also update product descriptions, developer-documentation links, and translation-contribution links.

Changes

Localized README updates

Layer / File(s) Summary
Move and expand Quick Start
README.md, README.jp.md, README.zh.md
The Quick Start sections and table-of-contents links move earlier in each README. The sections describe installation options, model configuration, and starting a conversation.
Update product descriptions
README.md, README.jp.md, README.zh.md
The Skills lists and custom-provider descriptions are updated. The English and Japanese READMEs correct the search API name; the Japanese README also revises its MCP toolchain description.
Update documentation and contribution links
README.md, README.jp.md, README.zh.md
The DeepWiki badge is removed. Developer-documentation and translation links are updated. The Chinese README also links to the Chinese contribution guide.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: yyhhyyyyyy


Merge Risk: ⚪ Minimal · up to bdd92

This PR only reorders and refreshes README content and links. It does not change product behavior and has no identified merge-blocking risk.

Architecture Summary

Architecture risk: 🔵 Low · up to bdd92

The change affects 3 systems.

Changed systems: README.jp.md, README.md, README.zh.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — README.jp.md (service) was modified; 1 changed file maps to changed impact.
  • observed — README.md (service) was modified; 1 changed file maps to changed impact.
  • observed — README.zh.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in README.jp.md: The DeepWiki badge link was removed.
  • observed — Modified behavior in README.jp.md: The table of contents adds links for the quick-start section and its download, model setup, and conversation subsections.
  • observed — Modified behavior in README.jp.md: The quick-start table-of-contents entries were removed from their former location.
  • observed — Modified behavior in README.jp.md: A quick-start section was added with GitHub Releases, the official website, and macOS Homebrew installation options; instructions for configuring a provider or Ollama and starting a conversation are also included.

Pre-merge checks | Passed 5
✅ 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 summarizes the main changes: reordering README sections and correcting outdated claims across the three localized README files.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Comment @coderabbitai help to get the list of available commands.

@zerob13
zerob13 merged commit b79c1b0 into dev Oct 10, 2026
12 checks passed
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.

1 participant