Skip to content

docs: rewrite open-source readmes#4

Merged
Pigbibi merged 1 commit into
mainfrom
codex/open-source-readme-ia-20260603
Jun 3, 2026
Merged

docs: rewrite open-source readmes#4
Pigbibi merged 1 commit into
mainfrom
codex/open-source-readme-ia-20260603

Conversation

@Pigbibi
Copy link
Copy Markdown
Contributor

@Pigbibi Pigbibi commented Jun 3, 2026

Summary

  • rewrite the repository README as an open-source project entry point rather than an internal build log
  • keep README.md English-only and README.zh-CN.md Chinese-only
  • document where the repository sits in the QuantStrategyLab architecture, including strategy package, snapshot pipeline, platform runtime, shared infrastructure, or research/audit boundaries
  • split direct runtime strategies from snapshot-backed strategy evidence where applicable

Validation

  • verified README.md contains no Chinese characters
  • verified README.zh-CN.md exists and contains the Chinese risk notice
  • verified required architecture sections are present
  • verified only README.md and README.zh-CN.md changed

Notes

  • HK strategy repositories are intentionally excluded from this batch because their profile names are being changed in another workstream.

@Pigbibi Pigbibi merged commit 29d8079 into main Jun 3, 2026
1 check passed
@Pigbibi Pigbibi deleted the codex/open-source-readme-ia-20260603 branch June 3, 2026 09:57
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