Repository navigation
docs: bilingual README (en + zh-CN) - #91
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
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.
Summary
Documentation-only change: rewrite
README.mdandREADME.zh-CN.mdto follow the QuantStrategyLab documentation style guide.Why
The READMEs did not follow the organization section structure, and the English and Simplified Chinese files were not kept in sync.
Changes
README.mdandREADME.zh-CN.mdmatching section for section, in the same order.Testing
Docs only. Ran the style guide section 13 grep checks (absolute home paths, buckets, personal subdomains, 40-character hex, status tables, dated audit titles, process narration) on both files; no matches.
Risk and rollback
Docs only; no runtime, configuration, or CI impact. Revert the commit to restore the previous READMEs.
Breaking changes
none