Skip to content

docs(multisig-for-protocols): normalize structure and wording - #585

Merged
mattaereal merged 6 commits into
developfrom
docs/normalize-multisig-for-protocols
Aug 5, 2026
Merged

mattaereal merged 6 commits into
developfrom
docs/normalize-multisig-for-protocols

Conversation

@mattaereal

Copy link
Copy Markdown
Collaborator

Scope

Normalize Multisig for Protocols (docs/pages/multisig-for-protocols/ including runbooks/).

Why

Overview lacked Key Takeaway and Related frameworks; child pages and runbooks had no canonical KT or fact-checked roles; structure was good but chrome incomplete vs content model (#561).

Content model applied

  • Framework overview page map + runbooks subsection + cross-links to Wallet Security
  • Canonical Key Takeaway on all content pages
  • Brief unheaded intros where pages jumped straight to H2
  • Related frameworks / Further reading on overview; HR before ContributeFooter

Changes

  • Overview rewrite (chrome + routing table as list)
  • KT + fact-checked on administration, signer, checklist, and runbook pages
  • Key Takeaways page kept; added page-level KT + fact-checked

Substantive security changes

None. Procedures, checklists, thresholds, and best-practice bodies preserved.

Intentionally unchanged

  • Implementation checklist content and <Checklist> blocks
  • Runbook procedure steps
  • Use-case separation tables and timelock guidance
  • key-takeaways numbered principles body

Validation

  • cspell
  • markdownlint-cli2 clean on touch paths
  • signed commit

Dependencies

#561 by reference only.

Reviewer focus

  • Overview map matches sidebar (including runbooks)
  • Wallet Security cross-links remain accurate
  • No accidental procedure edits in runbooks

Add canonical Key Takeaways across the framework andT runbooks, rewrite
overview page map with role routing and related frameworks, add fact-checked
roles and Further reading separators. Preserve procedure and checklist bodies.
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 27, 2026 •

Copy link
Copy Markdown

Deploying frameworks with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6a9c8d8
Status: ✅  Deploy successful!
Preview URL: https://51050320.frameworks-573.pages.dev
Branch Preview URL: https://docs-normalize-multisig-for.frameworks-573.pages.dev

View logs

mattaereal and others added 5 commits July 27, 2026 00:53
Rewrite non-stub frontmatter descriptions into the acceptable length
band (preferred 140–160). Stub pages exempt. No body or credit changes.
Child pages missing a canonical further/related H2 failed the updated #561 validator. Add a minimal Further Reading block linking the framework overview.
Neutralize fence comments that look like headings, canonicalize overview page-map titles, clamp descriptions, demote excess H2s, and mark template pages with content-model exceptions.

@scode2277 scode2277 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@frameworks-volunteer frameworks-volunteer left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Model: z-ai/glm-5.2 Reasoning: medium Provider: openrouter

Security review: clean. No secrets, injection vectors, unsafe deserialization, or sensitive data exposure. Dependencies unchanged.

QA review: all 33 internal links resolve to real files. Frontmatter valid across all 19 touched pages (title, description, tags, contributors with fact-checked role added). Key Takeaway format matches the canonical style guide pattern. Heading hierarchy fixes are correct (H2→H3 demotions for Testing/Preparation, Troubleshooting, Escalation, Practice on Testnet, Emergency Drill Procedures). key-takeaways.mdx cleanup (removing unused TagProvider/TagFilter wrappers) is appropriate. No leftover debug content or placeholder text.

One non-blocking observation: the overview page uses ## Further reading (sentence case, matching the style guide) while all 18 child pages use ## Further Reading (Title Case). The Title Case form matches the precedent set by recently merged normalization PRs (#576, #580, #582, #583), so the child pages are consistent with the current repo state. This is a repo-wide inconsistency, not a PR-specific defect.

LGTM — substantive security content preserved, chrome and structure normalized correctly.

@mattaereal
mattaereal merged commit ac465d6 into develop Aug 5, 2026
6 checks passed
@scode2277
scode2277 deleted the docs/normalize-multisig-for-protocols branch August 6, 2026 15:55
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.

3 participants