docs(devsecops): normalize structure and wording - #587
Open
mattaereal wants to merge 4 commits into
Open
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: |
4845e31
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://19204d2c.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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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)