Repository navigation
docs(guides): replace the residual "These checks confirm" lines with use-case expect blocks - #2611
Merged
bruno-andrade-azion merged 15 commits intoNov 11, 2026
Conversation
…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.
…ated writing rules (#2615)
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>
Co-authored-by: Bruno Germano <[email protected]>
…the CLI cannot bind a deployment (#2567) Co-authored-by: Bruno Germano <[email protected]>
…e JWT paywall steps (#2565) Co-authored-by: Bruno Germano <[email protected]>
…#2637) Co-authored-by: Bruno Germano <[email protected]>
#2566) 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
requested a review
from marcus-souza-azion
as a code owner
November 11, 2026 19:47
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
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 & 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-siemsand the WAFapply-rule-setexample.#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, underIn 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
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 theNo caso de uso […](…), espere:form.live.example.cominpoint-domain, the hostname that the live-stream guide uses for the same use case.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.answer-questions-from-a-vector-table,route-an-api-path-to-a-backend). Each section gets its own block, asdeliver-a-live-stream-from-live-ingestalready does.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-mcpandroute-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 grepfor both residue patterns returns 0 matches. The real sentence inconnector-azion-edge-storage.mdx("Two checks confirm the delivery…") stays.namespace.docs_gate.py --checkreports the same 2 findings before and after the change: a pre-existing&on line 27 of the auth-layer pair.linkcheck.pyon the 58 changed files reports 0 broken links, 0 cross-language links and 0 unpaired namespaces.---separator.mainas 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.Type of change
feat)fix) — typo, broken link, wrong informationdocs) — rewrite, expansion, upkeepi18n)refactor/chore) — reviewed by UXE, no content mixed inAuthor checklist
type(scope): summary(see GOVERNANCE.md §4)title,description,meta_tags,namespace,permalink,last_reviewed— no frontmatter is added or changedlinkcheck.pyreports 0 brokenpt-brupdated in this PR or follow-upi18nissue created: —pt-bris updated in this PRpnpm build:local(build + frontmatter check) without errors — not run locally; CI's Build check runs on this branch