Skip to content

docs: human-readable README ordering and governance file cleanup - #77

Merged
Pigbibi merged 1 commit into
mainfrom
docs/human-readable-governance-and-readme
Oct 6, 2026
Merged

Pigbibi merged 1 commit into
mainfrom
docs/human-readable-governance-and-readme

Conversation

@Pigbibi

@Pigbibi Pigbibi commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Move the "QSL architecture role" field list in README.md/README.zh-CN.md below the human-readable "What this repository is" intro (ordering only, no factual changes).
  • Remove the templated "中文摘要" meta-description block from CONTRIBUTING.md, SECURITY.md, and CODE_OF_CONDUCT.md — it was duplicated near-verbatim across sibling QuantStrategyLab repos and added no information beyond the existing English prose.

Test plan

  • Docs-only change; no code/config/workflow logic touched.
  • Reviewed rendered Markdown locally for broken links/headings.

🤖 Generated with Claude Code

README/README.zh-CN: move the "QSL architecture role" field list below
the human-readable "What this repository is" intro instead of leading
with it.

CONTRIBUTING/SECURITY/CODE_OF_CONDUCT: remove the boilerplate "中文摘要"
meta-description block duplicated verbatim across sibling repos; no
information lost, prose already covers the same ground in English.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@Pigbibi
Pigbibi merged commit 0c96b62 into main Oct 6, 2026
2 checks passed
@Pigbibi
Pigbibi deleted the docs/human-readable-governance-and-readme branch October 6, 2026 17:45
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