Skip to content

docs: rewrite governance templates into human-readable prose - #245

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

Continuation of the QSL sibling-repo documentation de-templating effort (11 repos already merged). This is a pure documentation rewrite — no code, config, or workflow logic changes.

  • README.md / README.zh-CN.md: moved the "QSL architecture role" field list to after the "What this repository is" human-readable introduction, so the narrative comes first. Content unchanged, only reordered. Chinese README link and the investment risk disclaimer are untouched.
  • CONTRIBUTING.md: removed the auto-generated "## 中文摘要" metadata block (identical boilerplate across all QSL sibling repos, just the repo name swapped in). Folded the relevant repo-specific risk note into Ground Rules as a rule about verifying strategy-promotion/live-enablement changes against documented evidence gates before merging.
  • SECURITY.md: removed the same "## 中文摘要" block; all security reporting process content is unchanged.
  • CODE_OF_CONDUCT.md: removed the "## 中文摘要" block. Its risk note overlapped with the existing Project Scope section, so merged the repo-specific point (discussions touching strategy promotion / live-enablement / live systems should stay evidence-based) into that section instead of duplicating it.

No other files contained the same template patterns.

Test plan

  • git diff --stat reviewed — only the 5 markdown files above changed, no code/config/workflow files touched.
  • Manually read each changed file end-to-end to confirm no factual content was dropped, only reordered/de-duplicated.
  • N/A automated tests (documentation-only change).

🤖 Generated with Claude Code

Drop the auto-generated "中文摘要" metadata blocks from CONTRIBUTING.md,
SECURITY.md, and CODE_OF_CONDUCT.md (a verbatim script artifact shared
across QSL sibling repos), folding any repo-specific risk notes into the
existing prose sections instead. Reorder README.md/README.zh-CN.md so the
human-readable "What this repository is" introduction comes before the
"QSL architecture role" field list, matching the sibling-repo rewrite
already merged elsewhere in the org.

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