Repository navigation
Fix: use "What this section covers" on nested subsection overviews - #615
Merged
Merged
Conversation
…What this framework covers"
frameworks-volunteer
approved these changes
Aug 28, 2026
frameworks-volunteer
left a comment
Collaborator
There was a problem hiding this comment.
Model: x-ai/grok-4.5 Reasoning: high Provider: openrouter
Security
- No secrets, auth changes, or executable surface beyond the existing content validator.
hasPageMapregex only expands accepted catalog H2 labels; no injection/path risk.
QA
- Scope matches intent: nested subsection overviews use
## What this section covers; top-level framework overviews stay on## What this framework covers. - Catalog/docs/tooling aligned:
validate-content.cjs,content-model.mdx,style-and-terminology.mdx,docs-normalization-checklist.mdx,config/template.mdx,AGENTS.md. - Spot-check of overview tree on this head: depth-3 keep framework label; the 17 touched nested overviews use section label; no leftover nested
framework coversH2s among pages that had the map heading. - Sentence case preserved; lint / Socket / sidebar-reminder green.
Nits (non-blocking)
- PR template “Type of change” checkboxes are all empty (tooling + edit to existing content).
- Validator accepts either label on any overview; it does not enforce framework-vs-section by path depth (docs mark them preferred by scope — fine if editorial judgment stays human).
- Pre-existing nested overviews still missing any page-map H2 (e.g. several under
opsec/) are untouched — out of scope here.
Verdict: Approve.
mattaereal
approved these changes
Aug 31, 2026
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
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.
What does this PR change?
I've updated the convention for nested subsection overviews (e.g.
opsec/passwords/overview) to have "What this section covers" instead of "What this framework covers"Changes
utils/validate-content.cjs: to accept the section-scoped titlescontent-model.mdx: catalog updatedstyle-and-terminology.mdx: sentence-case row for the new labeldocs-normalization-checklist.mdx: item now checks the H2 matches page scopeconfig/template.mdx: acceptable-titles comment updatedAGENTS.md: catalog-label line mentions the section variant## What this section coversType of change
If applicable
vocs.config.tswith thedev: trueparameterStuck on anything? Just write it here and we're happy to help.