Skip to content

docs(guides): replace the residual "These checks confirm" lines with use-case expect blocks - #2611

Merged
bruno-andrade-azion merged 15 commits into
mainfrom
docs/mm-16252-remove-use-case-template-residue
Nov 11, 2026
Merged

bruno-andrade-azion merged 15 commits into
mainfrom
docs/mm-16252-remove-use-case-template-residue

Conversation

@bruno-andrade-azion

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

Copy link
Copy Markdown
Contributor

What & why

Related issue: MM-16252 (T40) · Epic MM-16212
Pages affected: 32 en guides and their 32 pt-br twins (see the diff), in the Applications, Availability, Data, AI, Security, Observability and Streaming guides, plus point-domain, integrate-siems and the WAF apply-rule-set example.

#2457 moved use-case values and checks into the guides. It also left These checks confirm the [<use case>](…) use case. (pt-br: Estas verificações confirmam o caso de uso […](…).) at the end of 39 confirm sections. The how-to style guide (style-guide/content/how-to-guides.mdx) and the azion-docs-writer skill put something else there: the use case's expected results, under In the [<use case>](<url>) use case, expect:. The residue line was a placeholder for that block, and in 33 of the 39 places the page had no expect block for that use case.

Residue lines → expect blocks

  • 36 of the 39 lines become an In the […] use case, expect: block, with the same link text and URL, and one or two bullets. Each bullet is a bold outcome followed by the check that proves it. The pt-br twins get the No caso de uso […](…), espere: form.
  • Every bullet restates a check that the section already runs, with the same paths, headers, status codes and values. No command, value or fact is new. The one value taken from outside the page is live.example.com in point-domain, the hostname that the live-stream guide uses for the same use case.
  • 3 lines stay deleted (run-bot-manager-on-selected-paths, summarize-text-with-ai-inference-and-cache-the-summary, deliver-a-live-stream-from-live-ingest), because the page already has an expect block for that use case.
  • Two guides had a residue line at the end of two different check sections for the same use case (answer-questions-from-a-vector-table, route-an-api-path-to-a-backend). Each section gets its own block, as deliver-a-live-stream-from-live-ingest already does.
  • In 10 places the guide held no values for the use case (framework-react, restrict-an-origin-to-azion-with-origin-ip-acl ×2, debug-functions-dts, auth-layer-object-storage-functions, point-domain ×2, integrate-siems ×3), even though the use-case page lists the guide under "Guides in this use case". The new block is what makes that listing hold: the guide now carries the use case's checks.

Scope. The ticket names the Applications cluster, but the same residue was reported in cluster 2 (finding #38, integrate-siems), cluster 4 (#32, create-mcp and route-an-api-path-to-a-backend) and cluster 6 (#25, debug-functions-dts), and none of those findings has its own task. This PR covers all of them. Ten guides outside this PR also hold use-case values with no expect block. They have no residue line, so they are left for a follow-up.

How I checked it

  • git grep for both residue patterns returns 0 matches. The real sentence in connector-azion-edge-storage.mdx ("Two checks confirm the delivery…") stays.
  • In the 64 changed pages, every (page, use case) pair that holds values now has an expect block: 48 of 48. Each en page has as many expect blocks as its pt-br twin, matched by namespace.
  • The skill's docs_gate.py --check reports the same 2 findings before and after the change: a pre-existing & on line 27 of the auth-layer pair. linkcheck.py on the 58 changed files reports 0 broken links, 0 cross-language links and 0 unpaired namespaces.
  • No changed file has three newlines in a row, and no paragraph sits directly on a --- separator.
  • The branch merges main as of docs(guides): make the auth layer and vector search tutorials runnable #2566. A merge with main has no conflicts, and the PR's own changes are insertions and the residue deletions only.
  • I didn't build the site or open the pages in a browser. CI's Build check renders them.

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 frontmatter is added or changed
  • No legacy "edge-" product names in the copy
  • How-to/tutorial content includes at least one runnable, copy-paste-tested code block — no code block is added or changed; the new bullets restate the checks of the existing blocks
  • Screenshots (if any) have alt text and follow image standards — no screenshot is added or changed
  • Internal links are relative and resolve locally — the new links are the use-case links of the removed lines; linkcheck.py reports 0 broken
  • 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: — pt-br is updated in this PR
  • I ran pnpm build:local (build + frontmatter check) without errors — not run locally; CI's Build check runs on this branch

…es (MM-16252)

PR #2457 left a "These checks confirm the <use case> use case." line at the
end of the confirm sections of 32 guides, and its pt-br twin in the same 32
pages. The how-to style guide defines only two use-case lines ("uses the
values of this example" and "use case, expect:"), so these lines are
template residue. Every page still links each use case from a Next steps
card or from the body, so no link is lost.
isaque-bock-azion and others added 14 commits November 9, 2026 13:28
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…the CLI cannot bind a deployment (#2567)

Co-authored-by: Bruno Germano <[email protected]>
…mplate-residue' into docs/mm-16252-expect-blocks

* origin/docs/mm-16252-remove-use-case-template-residue:
  docs(guides): remove the residual "These checks confirm" use-case lines (MM-16252)
… results (MM-16252)

The residual "These checks confirm the <use case> use case." lines stood
where the how-to style guide puts the use case's expected results, under
"In the [<use case>](<url>) use case, expect:". Rewrite each removed line
as that block, in en and pt-br, so every guide that holds a use case's
values or that its use-case page lists also holds its checks.

Each bullet restates a check the section already runs. Three lines named a
use case that already had an expect block on the page, so they stay
deleted.
@bruno-andrade-azion bruno-andrade-azion changed the title docs(guides): remove the residual "These checks confirm" use-case lines docs(guides): replace the residual "These checks confirm" lines with use-case expect blocks Nov 11, 2026
@bruno-andrade-azion
bruno-andrade-azion merged commit ee0f695 into main Nov 11, 2026
9 of 10 checks passed
@bruno-andrade-azion
bruno-andrade-azion deleted the docs/mm-16252-remove-use-case-template-residue branch November 11, 2026 20:52
bruno-andrade-azion pushed a commit that referenced this pull request Nov 11, 2026
* origin/main:
  fix(marketplace): drop the Azion CLI prerequisite from firewall integration guides (#2612)
  docs(guides): replace the residual "These checks confirm" lines with use-case expect blocks (#2611)
  docs(guides): make the auth layer and vector search tutorials runnable (#2566)
  chore(scripts): add pnpm lint:terraform to validate Terraform samples (#2637)
  fix(firewall): correct the CLI binding, the WAF config sample, and the JWT paywall steps (#2565)
  docs(cli): document azion workload-deployment and fix pages that say the CLI cannot bind a deployment (#2567)
  docs(terraform): rewrite the samples for provider v2.10.0 (#2557)
  chore(deploy): promote docs-v2.4.4 to production (#2631)
  chore(main): release docs 2.4.4 (#2627)
  chore(deploy): promote docs-v2.4.3 to production (#2617)
  fix(applications): apply live test results and define each resource by its role (#2626)
bruno-andrade-azion pushed a commit that referenced this pull request Nov 11, 2026
* origin/main:
  fix(marketplace): drop the Azion CLI prerequisite from firewall integration guides (#2612)
  docs(guides): replace the residual "These checks confirm" lines with use-case expect blocks (#2611)
  docs(guides): make the auth layer and vector search tutorials runnable (#2566)
  chore(scripts): add pnpm lint:terraform to validate Terraform samples (#2637)
  fix(firewall): correct the CLI binding, the WAF config sample, and the JWT paywall steps (#2565)
  docs(cli): document azion workload-deployment and fix pages that say the CLI cannot bind a deployment (#2567)
  docs(terraform): rewrite the samples for provider v2.10.0 (#2557)
  chore(deploy): promote docs-v2.4.4 to production (#2631)
  chore(main): release docs 2.4.4 (#2627)
  chore(deploy): promote docs-v2.4.3 to production (#2617)
  fix(applications): apply live test results and define each resource by its role (#2626)
bruno-andrade-azion pushed a commit that referenced this pull request Nov 11, 2026
…-main

* origin/main: (21 commits)
  feat(nav): give every breadcrumb crumb a page and make CLI commands runnable (#2636)
  fix(cli): drop azion update workload-deployment, which the CLI does not expose (#2639)
  docs(terminology): retire Edge Node, module, and add-on from current pages (#2618)
  docs(migration): share the repeated migration-guide procedures as partials (#2619)
  fix(marketplace): drop the Azion CLI prerequisite from firewall integration guides (#2612)
  docs(guides): replace the residual "These checks confirm" lines with use-case expect blocks (#2611)
  docs(guides): make the auth layer and vector search tutorials runnable (#2566)
  chore(scripts): add pnpm lint:terraform to validate Terraform samples (#2637)
  fix(firewall): correct the CLI binding, the WAF config sample, and the JWT paywall steps (#2565)
  docs(cli): document azion workload-deployment and fix pages that say the CLI cannot bind a deployment (#2567)
  docs(terraform): rewrite the samples for provider v2.10.0 (#2557)
  chore(deploy): promote docs-v2.4.4 to production (#2631)
  chore(main): release docs 2.4.4 (#2627)
  chore(deploy): promote docs-v2.4.3 to production (#2617)
  fix(applications): apply live test results and define each resource by its role (#2626)
  chore(main): release docs 2.4.3 (#2616)
  docs(applications): review the Applications section and apply the updated writing rules (#2615)
  chore(deps): bump npm and GitHub Actions dependencies (#2590)
  chore(deploy): promote docs-v2.4.2 to production (#2610)
  chore(main): release docs 2.4.2 (#2609)
  ...
bruno-andrade-azion pushed a commit that referenced this pull request Nov 11, 2026
* commit '7aa84b1d0': (22 commits)
  docs(nav): apply the review of the orphan-page triage
  feat(nav): give every breadcrumb crumb a page and make CLI commands runnable (#2636)
  fix(cli): drop azion update workload-deployment, which the CLI does not expose (#2639)
  docs(terminology): retire Edge Node, module, and add-on from current pages (#2618)
  docs(migration): share the repeated migration-guide procedures as partials (#2619)
  fix(marketplace): drop the Azion CLI prerequisite from firewall integration guides (#2612)
  docs(guides): replace the residual "These checks confirm" lines with use-case expect blocks (#2611)
  docs(guides): make the auth layer and vector search tutorials runnable (#2566)
  chore(scripts): add pnpm lint:terraform to validate Terraform samples (#2637)
  fix(firewall): correct the CLI binding, the WAF config sample, and the JWT paywall steps (#2565)
  docs(cli): document azion workload-deployment and fix pages that say the CLI cannot bind a deployment (#2567)
  docs(terraform): rewrite the samples for provider v2.10.0 (#2557)
  chore(deploy): promote docs-v2.4.4 to production (#2631)
  chore(main): release docs 2.4.4 (#2627)
  chore(deploy): promote docs-v2.4.3 to production (#2617)
  fix(applications): apply live test results and define each resource by its role (#2626)
  chore(main): release docs 2.4.3 (#2616)
  docs(applications): review the Applications section and apply the updated writing rules (#2615)
  chore(deps): bump npm and GitHub Actions dependencies (#2590)
  chore(deploy): promote docs-v2.4.2 to production (#2610)
  ...
bruno-andrade-azion pushed a commit that referenced this pull request Nov 12, 2026
* origin/main: (24 commits)
  chore(nav): count only visible rows toward the navcheck soft max (#2640)
  docs(nav): triage the pages outside the navigation (#2593)
  fix(guides): match the QStash variable and the Functions usage response to the code (#2571)
  feat(nav): give every breadcrumb crumb a page and make CLI commands runnable (#2636)
  fix(cli): drop azion update workload-deployment, which the CLI does not expose (#2639)
  docs(terminology): retire Edge Node, module, and add-on from current pages (#2618)
  docs(migration): share the repeated migration-guide procedures as partials (#2619)
  fix(marketplace): drop the Azion CLI prerequisite from firewall integration guides (#2612)
  docs(guides): replace the residual "These checks confirm" lines with use-case expect blocks (#2611)
  docs(guides): make the auth layer and vector search tutorials runnable (#2566)
  chore(scripts): add pnpm lint:terraform to validate Terraform samples (#2637)
  fix(firewall): correct the CLI binding, the WAF config sample, and the JWT paywall steps (#2565)
  docs(cli): document azion workload-deployment and fix pages that say the CLI cannot bind a deployment (#2567)
  docs(terraform): rewrite the samples for provider v2.10.0 (#2557)
  chore(deploy): promote docs-v2.4.4 to production (#2631)
  chore(main): release docs 2.4.4 (#2627)
  chore(deploy): promote docs-v2.4.3 to production (#2617)
  fix(applications): apply live test results and define each resource by its role (#2626)
  chore(main): release docs 2.4.3 (#2616)
  docs(applications): review the Applications section and apply the updated writing rules (#2615)
  ...
bruno-andrade-azion pushed a commit that referenced this pull request Nov 12, 2026
…y-filter-removal

* origin/main: (24 commits)
  chore(nav): count only visible rows toward the navcheck soft max (#2640)
  docs(nav): triage the pages outside the navigation (#2593)
  fix(guides): match the QStash variable and the Functions usage response to the code (#2571)
  feat(nav): give every breadcrumb crumb a page and make CLI commands runnable (#2636)
  fix(cli): drop azion update workload-deployment, which the CLI does not expose (#2639)
  docs(terminology): retire Edge Node, module, and add-on from current pages (#2618)
  docs(migration): share the repeated migration-guide procedures as partials (#2619)
  fix(marketplace): drop the Azion CLI prerequisite from firewall integration guides (#2612)
  docs(guides): replace the residual "These checks confirm" lines with use-case expect blocks (#2611)
  docs(guides): make the auth layer and vector search tutorials runnable (#2566)
  chore(scripts): add pnpm lint:terraform to validate Terraform samples (#2637)
  fix(firewall): correct the CLI binding, the WAF config sample, and the JWT paywall steps (#2565)
  docs(cli): document azion workload-deployment and fix pages that say the CLI cannot bind a deployment (#2567)
  docs(terraform): rewrite the samples for provider v2.10.0 (#2557)
  chore(deploy): promote docs-v2.4.4 to production (#2631)
  chore(main): release docs 2.4.4 (#2627)
  chore(deploy): promote docs-v2.4.3 to production (#2617)
  fix(applications): apply live test results and define each resource by its role (#2626)
  chore(main): release docs 2.4.3 (#2616)
  docs(applications): review the Applications section and apply the updated writing rules (#2615)
  ...
bruno-andrade-azion pushed a commit that referenced this pull request Nov 12, 2026
* origin/main: (29 commits)
  fix(structure): tag bare code fences, fix heading skips, add pt-br meta_tags (#2629)
  docs(style-guide): drop the nonexistent GlossaryFilter from the glossary template (#2577)
  docs(release-notes): fix the October 14 anchor and merge the duplicate February 24 entry (#2572)
  fix(orchestrator): fix broken bind and create-service API samples (#2574)
  docs(readability): split the long sentences in the Runtime, CLI, Reference, and KV Store pages (#2635)
  chore(nav): count only visible rows toward the navcheck soft max (#2640)
  docs(nav): triage the pages outside the navigation (#2593)
  fix(guides): match the QStash variable and the Functions usage response to the code (#2571)
  feat(nav): give every breadcrumb crumb a page and make CLI commands runnable (#2636)
  fix(cli): drop azion update workload-deployment, which the CLI does not expose (#2639)
  docs(terminology): retire Edge Node, module, and add-on from current pages (#2618)
  docs(migration): share the repeated migration-guide procedures as partials (#2619)
  fix(marketplace): drop the Azion CLI prerequisite from firewall integration guides (#2612)
  docs(guides): replace the residual "These checks confirm" lines with use-case expect blocks (#2611)
  docs(guides): make the auth layer and vector search tutorials runnable (#2566)
  chore(scripts): add pnpm lint:terraform to validate Terraform samples (#2637)
  fix(firewall): correct the CLI binding, the WAF config sample, and the JWT paywall steps (#2565)
  docs(cli): document azion workload-deployment and fix pages that say the CLI cannot bind a deployment (#2567)
  docs(terraform): rewrite the samples for provider v2.10.0 (#2557)
  chore(deploy): promote docs-v2.4.4 to production (#2631)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/observe/real-time-events/data-sources.mdx
#	apps/docs/src/content/docs/pt-br/pages/observe/real-time-events/fontes-de-dados.mdx
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.

4 participants