docs(devsecops): normalize structure and wording - #587
Conversation
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).
Deploying frameworks with
|
| 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 |
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
left a comment
There was a problem hiding this comment.
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:
-
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##. -
Heading capitalization inconsistency —
data-security-upgrade-checklist.mdxandgovernance-proposal-security.mdxuse## 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.
…d imports and components usage
|
Model: 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:
One minor note (non-blocking): overview.mdx has Verdict: Approve. No blocking issues found. |
Scope
Normalize
docs/pages/devsecops/**(16 hand-authored pages under the root andisolation/) to the SEAL content model.Why
Apply the structural and editorial contract from the content-normalization standard so DevSecOps matches other frameworks.
Content model
Changes
vocs.config.ts, Related frameworksfact-checked: []where missing; rename## References→## Further reading; description length bandContributeFooterSwing | SEALfor length; MD022/MD032 cleanups around headings/listsvocs.config.tsor generated index changesSubstantive security
None — structure, frontmatter, labels, and chrome only. Guidance bodies preserved.
Intentionally unchanged
index.mdxfilesValidation
npx markdownlint-cli2 "docs/pages/devsecops/**/*.mdx"— 0 issuespnpm exec cspell "docs/pages/devsecops/**/*.mdx"— 0 issuesDependencies
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
wrote: []avoided (overview credits mattaereal from history)