Skip to content

docs(devsecops): normalize structure and wording - #587

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

docs(devsecops): normalize structure and wording#587
mattaereal wants to merge 6 commits into
developfrom
docs/normalize-devsecops

Conversation

@mattaereal

Copy link
Copy Markdown
Collaborator

Scope

Normalize docs/pages/devsecops/** (16 hand-authored pages under the root and isolation/) to the SEAL content model.

Why

Apply the structural and editorial contract from the content-normalization standard so DevSecOps matches other frameworks.

Content model

  • Framework overview with Key Takeaway, unheaded intro, full sidebar page map, Related frameworks
  • Leaf pages: contributors chrome, fact-checked role, canonical KT where missing, Further reading
  • Editorial only; no new security claims

Changes

  • Overview: contributors, description band, ordered page map matching vocs.config.ts, Related frameworks
  • All hand pages: add fact-checked: [] where missing; rename ## References## Further reading; description length band
  • IDEs + Data Security Checklist: add Key Takeaway (+ short intro on checklist)
  • Developer Machine Confinement: wire ContributeFooter
  • Isolation hub: include Developer Machine Confinement in section map
  • Governance title suffix Swing | SEAL for length; MD022/MD032 cleanups around headings/lists
  • No vocs.config.ts or generated index changes

Substantive security

None — structure, frontmatter, labels, and chrome only. Guidance bodies preserved.

Intentionally unchanged

  • Generated index.mdx files
  • Procedure/checklist substance and isolation technical depth
  • Sidebar YAML (already complete)

Validation

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

Dependencies

Depends on (by reference, unmerged): #561 — Content normalization standard. Do not merge this PR in place of #561; apply #561’s content-model / style as review criteria.

Reviewer focus

  • Overview map vs sidebar completeness
  • Empty wrote: [] avoided (overview credits mattaereal from history)
  • No accidental guidance changes in isolation/governance

Align DevSecOps pages with the content model: fact-checked role, canonical
Key Takeaways, overview sidebar map, Further reading headings, and chrome
fixes (footer on developer confinement, IDE/data checklist takeaways).
@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: e9b56f7
Status: ✅  Deploy successful!
Preview URL: https://ae9d2ec9.frameworks-573.pages.dev
Branch Preview URL: https://docs-normalize-devsecops.frameworks-573.pages.dev

View logs

Match develop authorship exactly. Clear wrote/reviewed/fact-checked
arrays where normalization invented authors on pages that had none.
Do not attribute chrome-only edits as content authorship.
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

Security + QA review of PR #587 (docs(devsecops): normalize structure and wording).

Security: Clean. No secrets, no injection vectors, no unsafe code patterns. Docs-only PR, no dependency changes. No concerns.

QA: Changes match the PR description across all 16 files. All CI checks pass (lint, sidebar-reminder, Cloudflare Pages, Socket Security). Overview page map matches vocs.config.ts sidebar. Related frameworks links verified to exist. Frontmatter is consistent.

Two minor issues:

  1. Heading hierarchy regression in execution-sandboxing-practical-guide.mdx — sections 6-8, the 30/60/90 day plan, and the Operational checklist were demoted from ## to ###. They now render as subsections of section 5 ("Resource and abuse controls") instead of siblings of sections 0-5. They are top-level sections and should stay at ##.

  2. Heading capitalization inconsistency — data-security-upgrade-checklist.mdx and governance-proposal-security.mdx use ## Further Reading (capital R) while the other 12 pages use ## Further reading (lowercase r). Pick one and apply it across all pages for consistency.

Neither issue is blocking. The PR is editorial-only with no security impact and all CI is green.

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

gtg now @mattaereal

@frameworks-volunteer

Copy link
Copy Markdown
Collaborator

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

Re-review confirmation for PR #587 (docs(devsecops): normalize structure and wording).

A review was already submitted by this bot (id 4860441597) — posting a comment instead of a duplicate review.

Security: Clean. No secrets, no injection vectors, no unsafe imports, no suspicious dependencies. All changes are MDX content/frontmatter only.

QA verification:

  • 16 files changed (+183/-70), all under docs/pages/devsecops/** — matches PR scope.
  • Description lengths: 140-155 chars, all within the 140-160 band. Pass.
  • Overview page map (15 items) matches vocs.config.ts sidebar order exactly. Developer Machine Confinement now listed in the sandboxing-and-isolation section map. Pass.
  • All Related frameworks links (secure-software-development, supply-chain, security-automation, infrastructure, incident-management) and all overview page-map links resolve to existing files. Pass.
  • All 15 leaf pages have fact-checked role in frontmatter; References renamed to "Further reading" consistently. Pass.
  • Key Takeaway added to IDEs and Data Security Checklist pages with <40-word summaries. Pass.
  • developer-machine-sandboxing.mdx: TagProvider/TagFilter removed, ContributeFooter wired in correctly. Pass.
  • governance-proposal-security.mdx title suffix changed to "| SEAL" (within 60-char title limit). Pass.
  • No vocs.config.ts or generated index.mdx changes. Pass.

One minor note (non-blocking): overview.mdx has wrote: [] which the PR description acknowledges as intentional (overview credits mattaereal from history via the other leaf pages). No action needed.

Verdict: Approve. No blocking issues found.

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