docs: restructure both READMEs for readability - #8
Merged
Merged
Conversation
Split the interleaved bilingual README into two single-language documents and give both the same layout. - README.md is now English-only; Chinese readers follow the language link to README.zh-CN.md, which was already a complete translation. This removes ~110 lines of duplicated prose from the English page. - Both files gain a centered header (badges, language switch, quick nav), a table of contents, and matching section structure. - Feature lists and the client-configuration index become tables; the read-only tool list collapses to a single line. - Setup steps become numbered subheadings; asides (new-to-MCP note, DSH env-forwarding limitation, provider-compatibility caveat) become blockquotes. - Deduplicate the repeated npm install / pip install block in the development section. - Fix two places where the Chinese page said less than the English one: absolute-path hiding now names display.expose_absolute_paths, and a stale claim that the npm CLI creates a virtualenv is removed in favor of the managed-engine wording used elsewhere. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
1 participant
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.
Cherry-picks the README restructuring work from
agent/readme-layout(split the bilingual README.md into English-only + README.zh-CN.md, add TOC/tables/matching section structure) onto currentmain, resolving conflicts against the now-merged Qoder-client terminology and incremental-sync/qoder-compat content.Summary
Test plan
npm run check(17 node tests, 5 python tests, publication check) — all pass