Skip to content

chore(lint): accept the use-case closing in lint-links - #2632

Merged
bruno-andrade-azion merged 2 commits into
mainfrom
chore/mm-16264-lint-links-use-case-closing
Nov 16, 2026
Merged

bruno-andrade-azion merged 2 commits into
mainfrom
chore/mm-16264-lint-links-use-case-closing

Conversation

@bruno-andrade-azion

@bruno-andrade-azion bruno-andrade-azion commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

What & why

Related issue: MM-16264, the code half of #2630
Pages affected: none. The only file changed is apps/docs/scripts/lint-links.ts.

The disagreement. The style guide's Use cases page requires every use case to close with ## Guides in this use case (pt-br ## Guias deste caso de uso), and #2630 writes that exception into the closing rule in Choose a content type. All 27 use-case pages in each language already close that way. pnpm lint:links predates the wording and accepted only Next steps/Related resources (pt-br Próximos passos/Recursos relacionados), so it listed all 54 pages under "pages with no closing links". AGENTS.md keeps content and code changes in separate pull requests, so this script change was left out of #2630.

The change. The script now records each nav row's kind. The use-case heading counts as canonical only on pages whose row has kind: use-case. Those rows all sit in the architectures tree (titled Use Cases), not in guides. A guide or product page that ends with that heading is still reported.

Dead ends for a use case. The style guide words the dead-end rule for Platform Resource pages: a closing link must reach a page of the page's own section other than its overview. A use case spans several products, and its closing cards point at guides. For a use case, the check therefore looks for a closing link to a page of the guides tree other than its root. Without this, the 54 pages would have moved from "no closing links" to "dead ends", because their own tree is architectures. A use-case closing that links only overviews is still a dead end.

Known gap. A use case that closes with ## Related resources or ## Next steps is still accepted as canonical, while the style guide gives a use case only ## Guides in this use case. Tightening that is left for a later change.

The spine check is unchanged. The 54 existing "does not link the "architectures" overview" rows stay, because use-case pages do not link the Use Cases overview. That is a content question for a separate pull request.

How I checked it

  • Ran pnpm lint:links with Node 26 before and after. Totals went from 1037 to 983 findings: no closing links 288 → 234, non-canonical headings 0 → 0, dead ends 138 → 138, spine gaps 611 → 611.
  • Diffed the full finding lists, using a throwaway copy of the script with the 40-row list cap lifted. Exactly 54 rows disappeared (27 en, 27 pt-br), each one a use-case page's last heading is "Guides in this use case" or "Guias deste caso de uso". No row was added.
  • After merging main (which added the landing exemption in feat(nav): give every breadcrumb crumb a page and make CLI commands runnable #2636), ran both versions again with the row cap lifted: 1130 → 1076 findings, no closing links 166 → 112, the other three rules unchanged. Exactly the same 54 use-case rows disappear, and no row is added.
  • Ran a negative test on local edits, which I reverted afterwards. A guide given that closing heading is still reported under "no closing links". A use-case closing that links only the Use Cases overview is reported as a dead end: no closing link into "guides" beyond its overview.
  • Ran prettier --check and a strict tsc --noEmit on the script. Both are clean.
  • Confirmed that lint:links runs in no workflow and no scripts/ci gate. It is referenced only in AGENTS.md and the two package.json files, and it stays warn-only unless --strict is passed.
  • Not run: pnpm build:local. The build does not use this script.

Type of change

  • 🆕 New content (feat)
  • 🩹 Fix (fix) — typo, broken link, wrong information
  • ♻️ Content update (docs) — rewrite, expansion, upkeep
  • 🌐 Translation sync (i18n)
  • 🏗️ Platform / structure (refactor / chore) — reviewed by UXE, no content mixed in

Author checklist

  • PR title follows type(scope): summary (see GOVERNANCE.md §4)
  • Frontmatter complete: title, description, meta_tags, namespace, permalink, last_reviewed — no page is added or changed
  • No legacy "edge-" product names in the copy — no copy is changed
  • How-to/tutorial content includes at least one runnable, copy-paste-tested code block — no how-to or tutorial is changed
  • Screenshots (if any) have alt text and follow image standards — no screenshot is added or changed
  • Internal links are relative and resolve locally — no link is added or changed
  • If any permalink changed or page moved: redirect added in this PR — no permalink changed and no page moved
  • i18n: pt-br updated in this PR or follow-up i18n issue created: — no page is changed; the script accepts the pt-br heading Guias deste caso de uso
  • I ran pnpm build:local (build + frontmatter check) without errors — not run: this PR changes only a lint script the build does not use

A use case closes with `## Guides in this use case` (pt-br `## Guias deste
caso de uso`), as the style guide's Use cases page requires, and lint:links
only knew `Next steps`/`Related resources`, so it reported all 27 use-case
pages in each language as having no closing links.

The heading now counts as canonical on pages whose nav row has
`kind: use-case`, and nowhere else. A use case spans several products, so
its dead-end check looks for a closing link into the guides tree, which is
where its cards point. The spine check is unchanged.
…inks-use-case-closing

* origin/main: (55 commits)
  docs(architectures): keep security-modernization and bot-management as API v3 versions (#2589)
  fix(runtime): clean up unused imports and JSDoc in the Node.js API samples (#2649)
  docs(platform): retire the v3 build and deploy journey pages (#2587)
  fix(compliance): correct the SOC report cadence and PCI DSS version (#2585)
  docs(runtime): fix the azion dev port and the function size limit (#2583)
  docs(console): apply the review of the Console path convention (#2644)
  docs(workloads): review the Workloads section with the style guide and correct it from live tests (#2570)
  fix(ai-inference): review the AI Inference section and correct it from live tests (#2641)
  docs(templates): apply the review of the migrated template guides (#2645)
  docs(templates): point Deploy links to the current Marketplace catalog (MM-16236) (#2582)
  docs(orchestrator): split how-tos into API v4 and API v3 pages (#2584)
  fix(accounts): hyphenate Real-Time Purge and name the Bills tab in the permissions table (#2581)
  chore(lint): accept the English-only Marketplace Agreement and lower the linkcheck baseline (#2647)
  fix(links): point the v3 Applications reference and the guides at the current pages (#2646)
  docs(runtime): migrate Node.js API samples to the ES Modules handler (MM-16245) (#2592)
  docs(observe): use the current GraphQL dataset names across Observe and guides (#2579)
  docs(templates): list the Astro templates that only the showcase covered (#2595)
  docs(orchestrator): consolidate duplicate guides and write How it works (#2588)
  docs(secure): retire the pre-Workloads security journey and guide pages (#2586)
  docs(applications): Run Function needs only Functions; fix WEBP and CORS prerequisites (#2580)
  ...
@bruno-andrade-azion
bruno-andrade-azion merged commit 34d478e into main Nov 16, 2026
9 checks passed
@bruno-andrade-azion
bruno-andrade-azion deleted the chore/mm-16264-lint-links-use-case-closing branch November 16, 2026 13:10
bruno-andrade-azion pushed a commit that referenced this pull request Nov 16, 2026
* origin/main: (71 commits)
  fix(opennext): migrate the OpenNext guide to the v4 azion.config.js format (#2651)
  chore(main): release docs 2.5.0 (#2638)
  docs(style-guide): settle closing names, sentence caps, and the date rule (#2630)
  chore(lint): accept the use-case closing in lint-links (#2632)
  feat(guides): add end-to-end tutorials for six products (#2652)
  fix(agreements): fix the FAQ index links and move the 2016 SLA off the current page (#2633)
  fix(functions): state that the Response Phase runs only Lua functions (#2650)
  docs(architectures): keep security-modernization and bot-management as API v3 versions (#2589)
  fix(runtime): clean up unused imports and JSDoc in the Node.js API samples (#2649)
  docs(platform): retire the v3 build and deploy journey pages (#2587)
  fix(compliance): correct the SOC report cadence and PCI DSS version (#2585)
  docs(runtime): fix the azion dev port and the function size limit (#2583)
  docs(console): apply the review of the Console path convention (#2644)
  docs(workloads): review the Workloads section with the style guide and correct it from live tests (#2570)
  fix(ai-inference): review the AI Inference section and correct it from live tests (#2641)
  docs(templates): apply the review of the migrated template guides (#2645)
  docs(templates): point Deploy links to the current Marketplace catalog (MM-16236) (#2582)
  docs(orchestrator): split how-tos into API v4 and API v3 pages (#2584)
  fix(accounts): hyphenate Real-Time Purge and name the Bills tab in the permissions table (#2581)
  chore(lint): accept the English-only Marketplace Agreement and lower the linkcheck baseline (#2647)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/angular-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/astro-blog-template.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/clean-astro-sanity.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/cosmic-agency-website.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/cosmic-simple-astro-blog.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/cosmicjs-simple-next-blog-template.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/devscard.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/docusaurus-javascript-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/docusaurus-typescript-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/dynamic-and-static-file-optimization.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/gatsby-blog-starter-kit.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/gatsby-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/htmx-minimal.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/hugo-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/jekyll-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/nextjs-static-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/nuxt-static-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/qstash-scheduler.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/qwik-minimal.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/react-book-store.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/static-cache.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/stencil-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/upstash-geolocation.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/upstash-rate-limiting.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/videoteca-static-cache.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/vite-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/vitepress-javascript-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/vitepress-typescript-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/webpage-to-pdf-resume.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/wordpress-edgeaccelerator.mdx
#	apps/docs/src/content/docs/en/pages/main-menu/additional-resources/templates-and-integrations/understand-azion-templates.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/angular-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/astro-blog-template.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/clean-astro-sanity.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/cosmic-agency-website.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/cosmic-simple-astro-blog.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/cosmic-simple-next-blog.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/devscard.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/docusaurus-javascript-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/docusaurus-typescript-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/dynamic-and-static-file-optimization.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/gatsby-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/gatsby-starter-kit.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/htmx-minimal.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/hugo-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/jekyll-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/next-static-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/nuxt-static-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/qstash-scheduler.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/qwik-minimal.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/react-book-store.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/static-cache.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/stencil-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/upstash-geolocation.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/upstash-rate-limiting.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/videoteca-static-cache.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/vite-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/vitepress-javascript-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/vitepress-typescript-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/webpage-to-pdf-resume.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/wordpress-edgeaccelerator.mdx
#	apps/docs/src/content/docs/pt-br/pages/menu-principal/recursos-adicionais/templates-e-integracoes/templates-visao-geral.mdx
bruno-andrade-azion pushed a commit that referenced this pull request Nov 16, 2026
* origin/main: (67 commits)
  fix(opennext): migrate the OpenNext guide to the v4 azion.config.js format (#2651)
  chore(main): release docs 2.5.0 (#2638)
  docs(style-guide): settle closing names, sentence caps, and the date rule (#2630)
  chore(lint): accept the use-case closing in lint-links (#2632)
  feat(guides): add end-to-end tutorials for six products (#2652)
  fix(agreements): fix the FAQ index links and move the 2016 SLA off the current page (#2633)
  fix(functions): state that the Response Phase runs only Lua functions (#2650)
  docs(architectures): keep security-modernization and bot-management as API v3 versions (#2589)
  fix(runtime): clean up unused imports and JSDoc in the Node.js API samples (#2649)
  docs(platform): retire the v3 build and deploy journey pages (#2587)
  fix(compliance): correct the SOC report cadence and PCI DSS version (#2585)
  docs(runtime): fix the azion dev port and the function size limit (#2583)
  docs(console): apply the review of the Console path convention (#2644)
  docs(workloads): review the Workloads section with the style guide and correct it from live tests (#2570)
  fix(ai-inference): review the AI Inference section and correct it from live tests (#2641)
  docs(templates): apply the review of the migrated template guides (#2645)
  docs(templates): point Deploy links to the current Marketplace catalog (MM-16236) (#2582)
  docs(orchestrator): split how-tos into API v4 and API v3 pages (#2584)
  fix(accounts): hyphenate Real-Time Purge and name the Bills tab in the permissions table (#2581)
  chore(lint): accept the English-only Marketplace Agreement and lower the linkcheck baseline (#2647)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/architectures/security-modernization/security-modernization-v3.mdx
#	apps/docs/src/content/docs/pt-br/pages/arquiteturas/security-modernization/security-modernization-v3.mdx
bruno-andrade-azion pushed a commit that referenced this pull request Nov 16, 2026
* origin/main: (66 commits)
  docs(templates): point the remaining Deploy links to the March 2026 catalog (#2599)
  fix(architectures): point Deploy buttons at the gallery template slugs (#2614)
  fix(opennext): migrate the OpenNext guide to the v4 azion.config.js format (#2651)
  chore(main): release docs 2.5.0 (#2638)
  docs(style-guide): settle closing names, sentence caps, and the date rule (#2630)
  chore(lint): accept the use-case closing in lint-links (#2632)
  feat(guides): add end-to-end tutorials for six products (#2652)
  fix(agreements): fix the FAQ index links and move the 2016 SLA off the current page (#2633)
  fix(functions): state that the Response Phase runs only Lua functions (#2650)
  docs(architectures): keep security-modernization and bot-management as API v3 versions (#2589)
  fix(runtime): clean up unused imports and JSDoc in the Node.js API samples (#2649)
  docs(platform): retire the v3 build and deploy journey pages (#2587)
  fix(compliance): correct the SOC report cadence and PCI DSS version (#2585)
  docs(runtime): fix the azion dev port and the function size limit (#2583)
  docs(console): apply the review of the Console path convention (#2644)
  docs(workloads): review the Workloads section with the style guide and correct it from live tests (#2570)
  fix(ai-inference): review the AI Inference section and correct it from live tests (#2641)
  docs(templates): apply the review of the migrated template guides (#2645)
  docs(templates): point Deploy links to the current Marketplace catalog (MM-16236) (#2582)
  docs(orchestrator): split how-tos into API v4 and API v3 pages (#2584)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants