Skip to content

Fix: use "What this section covers" on nested subsection overviews - #615

Merged
mattaereal merged 2 commits into
developfrom
fix/subsections-overviews
Aug 31, 2026
Merged

mattaereal merged 2 commits into
developfrom
fix/subsections-overviews

Conversation

@scode2277

Copy link
Copy Markdown
Collaborator

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 titles
  • content-model.mdx: catalog updated
  • style-and-terminology.mdx: sentence-case row for the new label
  • docs-normalization-checklist.mdx: item now checks the H2 matches page scope
  • config/template.mdx: acceptable-titles comment updated
  • AGENTS.md: catalog-label line mentions the section variant
  • 17 nested overviews renamed to ## What this section covers

Type of change

  • New content
  • Edit to existing content
  • Outline / structure change
  • Typo or formatting fix
  • Tooling / config

If applicable

  • Editing existing content: tagged the current contributors from the attribution list
  • Framework has a steward: asked them to review
  • Outline change: updated vocs.config.ts with the dev: true parameter
  • Want community feedback: shared this PR in our Discord

Stuck on anything? Just write it here and we're happy to help.

@scode2277 scode2277 added the enhancement Updates that improve or refine existing features, user experience, or system performance. label Aug 28, 2026

@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: x-ai/grok-4.5 Reasoning: high Provider: openrouter

Security

  • No secrets, auth changes, or executable surface beyond the existing content validator.
  • hasPageMap regex 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 covers H2s 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.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying frameworks with  Cloudflare Pages  Cloudflare Pages

Latest commit: cee841a
Status:⚡️  Build in progress...

View logs

@mattaereal
mattaereal merged commit 99efcc8 into develop Aug 31, 2026
5 of 6 checks passed
@scode2277
scode2277 deleted the fix/subsections-overviews branch September 3, 2026 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Updates that improve or refine existing features, user experience, or system performance.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants