Skip to content

docs: bilingual README (en + zh-CN) - #212

Merged
Pigbibi merged 3 commits into
mainfrom
docs/readme-bilingual-20261016
Oct 16, 2026
Merged

Pigbibi merged 3 commits into
mainfrom
docs/readme-bilingual-20261016

Conversation

@Pigbibi

@Pigbibi Pigbibi commented Oct 16, 2026

Copy link
Copy Markdown
Collaborator

Summary

Documentation-only change. Align README.md and README.zh-CN.md with the
QuantStrategyLab documentation style guide.

Why

The previous READMEs described internal process, listed internal documents, and
diverged between English and Chinese, with the Chinese file carrying details the
English file lacked.

Changes

  • Rewrite the English README to the required section order (Status, What this
    is, What this is not, Quick start, Configuration, Repository layout,
    Contributing, Security, License).
  • Add a matching Simplified Chinese README with the same sections, order,
    commands, links, and configuration names.
  • Present runtime environment variables as a configuration table with required
    and default columns, using placeholders for bucket and project identifiers.
  • Remove the monthly API review process notes and internal document links.

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

@Pigbibi
Pigbibi marked this pull request as ready for review October 16, 2026 17:02
@Pigbibi
Pigbibi merged commit 17e5cc5 into main Oct 16, 2026
1 check passed
@Pigbibi
Pigbibi deleted the docs/readme-bilingual-20261016 branch October 16, 2026 17:03
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