Skip to content

docs(supply-chain): normalize structure and wording - #601

Open
scode2277 wants to merge 2 commits into
developfrom
docs/normalize-supply-chain
Open

docs(supply-chain): normalize structure and wording#601
scode2277 wants to merge 2 commits into
developfrom
docs/normalize-supply-chain

Conversation

@scode2277

Copy link
Copy Markdown
Collaborator

What does this PR change?

Normalize docs/pages/supply-chain/** only, plus two words added to wordlist.txt required by
cspell for the new citations. No other frameworks. No sidebar or vocs.config.ts changes.

Why

Supply Chain was the last framework with no normalization PR, merged or open. Every page failed
validate:content on the canonical Key Takeaway label, and four failed on description length.
Headings were Title Case throughout, predating the sentence-case rule from #595.

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.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying frameworks with  Cloudflare Pages  Cloudflare Pages

Latest commit: 51ce4d8
Status: ✅  Deploy successful!
Preview URL: https://ddb3967a.frameworks-573.pages.dev
Branch Preview URL: https://docs-normalize-supply-chain.frameworks-573.pages.dev

View logs

@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 review: PASS. No secrets, no injection vectors, no unsafe code patterns. All 12 newly added external URLs point to legitimate, well-known security sources (Wiz, CFTC, Halborn, samczsun, LlamaRisk, CoinDesk, LayerZero Labs, Trezor, Ledger, GHSA, NIST, SLSA, OpenSSF). wordlist.txt additions (CFTC, Veridise) are benign.

QA review: PASS. All changes correctly align with the content model and style guide:

  • Key Takeaway label normalized to canonical form **Key Takeaway**: (colon outside bold) per content-model.mdx L216
  • Headings converted from Title Case to sentence case per style guide
  • frontendfront end (noun) / front-end (adjective) per style-and-terminology.mdx L142
  • supply chain (noun) / supply-chain (adjective) usage per L141
  • Descriptions rewritten to the 140-170 char range per content-model.mdx L187
  • Page map in overview.mdx reordered to match sidebar order in vocs.config.ts L516-521
  • New ## Further reading section in overview.mdx has one-line descriptions per content-model L264
  • ## Further Reading## Further reading sentence case per L261
  • Internal links all resolve to existing pages
  • Frontmatter contributors use scode2277 (no frameworks-volunteer)
  • No leftover debug content or TODOs

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.

2 participants