Skip to content

docs(physical-security): normalize structure and wording - #588

Open
mattaereal wants to merge 6 commits into
developfrom
docs/normalize-physical-security
Open

docs(physical-security): normalize structure and wording#588
mattaereal wants to merge 6 commits into
developfrom
docs/normalize-physical-security

Conversation

@mattaereal

Copy link
Copy Markdown
Collaborator

Scope

Normalize docs/pages/physical-security/** (14 hand-authored pages).

Why

Match the SEAL content model used by other framework PRs.

Content model

  • Canonical > 🔑 **Key Takeaway**: on every page (added for checklist)
  • Description length band; fact-checked already present
  • Root and coercion overviews: Related frameworks
  • Stub notices retained on facility / counter-surveillance / supply-chain physical sections
  • Prose wrap for MD013; no invented guidance

Changes

  • Overview page maps and chrome; related-framework cross-links
  • Coercion & duress: KT format, checklist takeaway
  • Line-length and blank-line cleanup across the family

Substantive security

None — editorial/structural only. Control recommendations preserved.

Intentionally unchanged

  • Generated index files
  • Sidebar (vocs.config.ts already complete; WIP dev: true stubs unchanged)
  • Substantive wallet/duress guidance bodies

Validation

  • npx markdownlint-cli2 "docs/pages/physical-security/**/*.mdx" — 0 issues
  • pnpm exec cspell "docs/pages/physical-security/**/*.mdx" — 0 issues
  • Signed commit

Dependencies

Depends on (by reference, unmerged): #561 — Content normalization standard.

Reviewer focus

  • Stub pages still clearly WIP
  • Coercion page map vs sidebar
  • No safety-guidance drift in wrench-attack content

Canonical Key Takeaways, description band, Related frameworks on
overviews, checklist takeaway, line-length and chrome cleanup across the
framework and coercion & duress subtree. Stub overviews preserved.
@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: d18ea61
Status: ✅  Deploy successful!
Preview URL: https://fbf54ddd.frameworks-573.pages.dev
Branch Preview URL: https://docs-normalize-physical-secu.frameworks-573.pages.dev

View logs

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.

@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

Reviewed all 14 changed MDX files in docs/pages/physical-security/**.

Security review: No issues. No secrets, no injection vectors, no unsafe code. The "secrets" mentions are security guidance prose, not code.

QA review:

  • All 14 files are editorial/structural normalization matching the SEAL content model
  • Key Takeaway format unified to > 🔑 **Key Takeaway**: across all pages
  • Prose re-wrapped for MD013 (line length); no substantive guidance changed
  • "Further Reading" sections added to all sub-pages with valid internal links
  • "Related frameworks" cross-links added to root overview — all 5 links verified to existing files
  • Stub pages retain ⚠️ Stub/in progress notices and use content-model-exception comments to defer page maps
  • Stub boundary markers (<!-- stub-boundary -->) cleanly separate stub content from substantive KT
  • Description fields tightened; all remain accurate and within length band
  • No debug content, TODOs, or placeholder text
  • No frontmatter contributors changes (correct — editorial only)

No blocking issues. Approving.

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown

Sidebar Configuration Reminder

Documentation files update:

New in this push:

  • docs/pages/physical-security/coercion-and-duress/index.mdx (added) ← NEW
  • docs/pages/physical-security/facility-and-perimeter/index.mdx (added) ← NEW
  • docs/pages/physical-security/index.mdx (added) ← NEW
  • docs/pages/physical-security/physical-counter-surveillance/index.mdx (added) ← NEW
  • docs/pages/physical-security/supply-chain-physical-integrity/index.mdx (added) ← NEW

Please ensure that:

  • The sidebar in vocs.config.ts has been updated to include these files
  • New content has the dev: true parameter so it's marked as under development
  • Sidebar links match the file paths - use the preview deployment to verify

See Contributing Guide – Sidebar & Navigation for more details.


This is an automated reminder. If this PR doesn't need sidebar changes, you can ignore this message.

@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.

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