Skip to content

docs: de-templatize README ordering and governance docs - #79

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

Documentation-only rewrite, continuing the de-templatization pass already merged in sibling QSL repos (e.g. BinancePlatform, QuantAdvisorResearch). No code, config, or workflow logic changes.

  • README.md / README.zh-CN.md: moved the "QSL architecture role" field list (Layer/Responsibility/Owns/Consumes/Must not) to after the human-readable "What this repository is" section instead of before it. Factual content unchanged, only reordered. Chinese README link and risk disclaimer kept at the top.
  • README.zh-CN.md: also de-duplicated a repeated "延伸文档" heading/list that had been split into two separate blocks; merged into one list, keeping every linked doc.
  • CONTRIBUTING.md / SECURITY.md / CODE_OF_CONDUCT.md: removed the generated "## 中文摘要" meta block (identical boilerplate across sibling repos, just with the repo name swapped). For CONTRIBUTING.md, the one risk point not already covered by the English body (verify strategy/automation/credential/cloud/broker/exchange changes via test env, dry run, or read-only evidence before touching production) was folded into the existing "Ground Rules" section instead of being dropped. The SECURITY.md and CODE_OF_CONDUCT.md summaries were already fully covered by their English bodies, so those blocks were removed with no merge needed.

Test plan

  • Read all 5 changed files end-to-end after edits to confirm structure, links, and bilingual consistency.
  • git diff --check — no whitespace errors.
  • Confirmed no src/, tests/, .github/workflows/, or config files were touched (git status scoped to the 5 doc files only).

🤖 Generated with Claude Code

Move the QSL architecture role field list after the human-readable
"What this repository is" section in README.md/README.zh-CN.md, and
drop the repeated "中文摘要" meta block from CONTRIBUTING.md,
SECURITY.md, and CODE_OF_CONDUCT.md. One substantive risk note (verify
strategy/automation/credential/cloud/broker/exchange changes before
production) is folded into CONTRIBUTING.md's Ground Rules instead of
being dropped. Also de-duplicates a repeated "延伸文档" heading in
README.zh-CN.md. No code, config, or workflow logic changes.

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