Skip to content

[style-harmonize] retrofit 5-field intro block on 10 legacy guides — 100% format conformance#45

Merged
weicao merged 1 commit intomainfrom
style-harmonize/intro-block-retrofit-batch-3
May 3, 2026
Merged

[style-harmonize] retrofit 5-field intro block on 10 legacy guides — 100% format conformance#45
weicao merged 1 commit intomainfrom
style-harmonize/intro-block-retrofit-batch-3

Conversation

@weicao
Copy link
Copy Markdown
Contributor

@weicao weicao commented May 3, 2026

Summary

Closes the format conformance gap on the final 10 methodology guides without a standardized 5-field intro block. Brings total coverage to 31/31 (100%) of methodology guides.

Why

Legacy nayutah-baseline guides predate the standardized intro block convention (codified in CONTRIBUTING.md / CLAUDE.md). Without intro block, readers cannot quickly classify Audience / Status / KB version applicability — slowing the 3-month-future-team test.

Quality dashboard fire #10 measurement: 21/31 → 31/31 = +32% absolute improvement on format conformance metric.

Files (10)

  • addon-bootstrap-role-publish-guide.md
  • addon-componentdefinition-upgrade-guide.md
  • addon-control-plane-election-guide.md
  • addon-ops-restart-troubleshooting-guide.md
  • addon-probe-script-fork-and-zombie-guide.md
  • addon-reconfigure-guide.md
  • addon-switchover-guide.md
  • addon-test-environment-gate-hygiene-guide.md
  • addon-test-host-stress-and-pollution-accumulation-guide.md (added missing KB version + Affected-by-skew, kept original 3 fields)
  • addon-tls-guide.md

KB version field per file content type

  • Methodology / design-principle docs (control-plane-election, switchover, bootstrap-role-publish): any
  • Test methodology (env-gate-hygiene, host-stress): any
  • KB API surface docs (componentdefinition-upgrade, ops-restart-troubleshooting): 1.0.x / 1.1.x / main
  • Reconfigure: 1.0.x / 1.1.x with cross-ref to version-skew (PR docs(reconfigure): add addon-reconfigure-version-skew-guide v1 draft #13 待 land)
  • Probe-fork-zombie: any (PID 1 reap is K8s contract)
  • TLS: any (cert-manager / Secret are K8s contracts)

Why this PR is low-risk

Test plan

  • All 10 files have 5-field intro block immediately after H1, before existing body
  • Markdown renders cleanly (blockquote with 5 bold-key lines)
  • No body content removed or modified
  • Format conformance dashboard metric reads 31/31

Closes the format conformance gap on the last 10 guides without
standardized intro block. Brings total coverage from 21/31 to 31/31
(100% format conformance for methodology guides).

Files (10):
- addon-bootstrap-role-publish-guide.md
- addon-componentdefinition-upgrade-guide.md
- addon-control-plane-election-guide.md
- addon-ops-restart-troubleshooting-guide.md
- addon-probe-script-fork-and-zombie-guide.md
- addon-reconfigure-guide.md
- addon-switchover-guide.md
- addon-test-environment-gate-hygiene-guide.md
- addon-test-host-stress-and-pollution-accumulation-guide.md (added
  missing KB version + Affected-by-skew, kept original 3 fields)
- addon-tls-guide.md

Pure structural addition: 5 lines per file (4 new fields + blank
separator); host-stress added 2 fields. Methodology body unchanged.

KB version field per file content:
- Methodology / design-principle docs (control-plane-election,
  switchover, bootstrap-role-publish): KB version = any
- Test methodology (env-gate-hygiene, host-stress-pollution): any
- KB API surface docs (componentdefinition-upgrade,
  ops-restart-troubleshooting): 1.0.x / 1.1.x / main
- Reconfigure: 1.0.x / 1.1.x with cross-ref to version-skew (PR #13)
- Probe-fork-zombie: any (PID 1 reap is K8s contract)
- TLS: any (cert-manager / Secret are K8s contracts)

Same retrofit pattern as PR #29 (case files batch) and PR #35 (4
guides batch 2).
@weicao weicao merged commit d1f2895 into main May 3, 2026
weicao added a commit that referenced this pull request May 4, 2026
…ection (#52)

Closes 6 nits across PR #50 + #51 (Fix validation sub-section abstracts / 设计教训 anti-pattern statements / Guard v1 strength progression abstracts / Source evidence index cross-repo path prefix) + adds new SKILL-INDEX ### OceanBase section with 2 case entries closing the cases/oceanbase/-to-SKILL-INDEX sync gap. Pure additive; methodology body unchanged. Same retrofit pattern as PR #29/#35/#41/#45/#48/#49.
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