Repository navigation
docs: bilingual README (en + zh-CN) - #70
Merged
Merged
Conversation
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
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.
Summary
Documentation-only change. Align
README.mdandREADME.zh-CN.mdwith theQuantStrategyLab documentation style guide.
Why
The previous READMEs used internal architecture language, listed internal
documents, and diverged between English and Chinese.
Changes
is, What this is not, Quick start, Configuration, Repository layout,
Contributing, Security, License).
commands, links, and configuration names.
architecture notes.
Testing
No code changed. Verified both files against the style-guide checklist and grep
list: no absolute home paths, non-placeholder buckets, personal subdomains,
40-character hex strings, status tables, dated audit titles, or process
narration. Confirmed the two files have the same sections in the same order.
Risk and rollback
Docs only. Revert the commit to roll back.
Breaking changes
none