Repository navigation
docs(style-guide): align the guide with the shipped sections and settle its open rules - #2600
Open
marcus-souza-azion wants to merge 5 commits into
Open
marcus-souza-azion wants to merge 5 commits into
marcus-souza-azion wants to merge 5 commits into
Conversation
…a mechanism page Bring the structure rules in line with the shipped sections, in en and pt-br: - Limits, Pricing, and Changelog are rows of a Platform Resource section, at the same level as the others; no Management parent. - The Guides and tutorials hub lists name, type, and last updated, and sorts alphabetically by navigation label, not by date or title. - A nested Product's Reference group opens with its mechanism page, a concept page titled for the mechanism; the resource's How it works keeps a short section that links it. Live Ingest joins the Connectors list. - Troubleshooting groups a nested Product's symptoms under one section, with each symptom one level down.
…nce names in English Terminology and the Overview pattern, in en and pt-br: - The sentence that defines an Azion element states its class: Platform Resource, Product, or Feature with its scope. A new Terminology section classifies section roots, nested Products, nested Platform Resources, and Features. The Overview template, its Functions example, and its resources entries carry the class. - The Overview mechanism opens with what the reader would assume wrong and says what happens instead. - A sentence about where the platform answers names the data center nearest to the user, never a distance. - A page ties the instance to its Platform Resource where it first appears: "An application is the object you create in Applications." - In Brazilian Portuguese, the instance keeps its US English name in lowercase (a application, a function, o workload, o connector, o firewall, o deployment, o bucket). The Bilingual pages substitution and the guide's own pt-br examples follow it.
Sentence structure gains the rules that keep a paragraph saying one thing, in en and pt-br: - Connect each sentence to the one before, and name a change of topic with its connective. - Let the first sentences of paragraphs and bullet lead-ins carry the section; a compressed bullet stays on its lead-in's topic. - Introduce one new term per sentence. - A restated list keeps its words, and an interface string follows the fact it implies. The checklist gains a line for each.
Each pair of pages now says one thing, in en and pt-br: - Reference pages: a version notice comes from the version snippets, never from a hand-written caution, as Components states. - Components: the changelog entry example uses description="Version 1.3.0", as Changelog pages states. - Changelog pages: a change to a Product nested in a Platform Resource opens with the Product as the subject. - Headings: an acronym is spelled out once per page, at its first mention, so a later heading that carries it needs no second expansion.
…ts format A contributor who drafts a pull request with an agent now gets the review checklist without asking for it: - The PR template returns to What & why, Type of change, and Author checklist, the #2307 format that CONTRIBUTING, GOVERNANCE, and AGENTS.md still call the review contract. The URL guidance from the short template becomes a comment on the redirect row. - AGENTS.md gains "The description": write in the template's format, keep every checklist row verbatim, explain a row that is not true on the same line, and write to pr.md when the agent does not open the PR. - CLAUDE.md imports AGENTS.md, because Claude Code reads only CLAUDE.md when both files exist. - AGENTS.md names the current redirect folder, apps/docs/redirects/, and CONTRIBUTING points to the redirect row instead of the removed section. - .gitignore ignores /pr.md.
marcus-souza-azion
requested review from
a team and
bruno-andrade-azion
as code owners
November 6, 2026 15:50
bruno-andrade-azion
approved these changes
Nov 6, 2026
This branch has not been deployed
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: none. The source is a comparison of the style guide, as published after #2561, with the shipped repository and with the rulings of the Applications and Workloads reviews.
Pages affected: 34 files in the style guide. 13 pages change in both languages, and 8 Portuguese pages change only in their examples. The
enpermalinks, under/en/documentation/style-guide/:content/information-architecture/,content/navigation-hubs/,content/choose-a-content-type/,content/concept/,content/overview/,content/troubleshooting/,content/reference/,content/changelog/writing/terminology/,writing/sentence-structure/,formatting/headings/,conventions/bilingual/,components//pt-br/documentacao/guia-de-estilo/:como-documentamos/docs-as-code/,conteudo/arquitetura/,conteudo/casos-de-uso/,conteudo/guias-multirrecurso/,conteudo/quickstart/,escrita/procedimentos/,formatacao/pontuacao/,formatacao/texto/.github/PULL_REQUEST_TEMPLATE.md,.github/CONTRIBUTING.md,AGENTS.md,CLAUDE.md,.gitignoreIn some places the style guide described one structure while the shipped sections use another. It was also silent on rules that recent reviews settled. In every case, this PR moves the guide to the rule. Pages that do not follow a new rule yet are left for later PRs: the guide describes the target, and this PR changes no page outside it.
The PR has 5 commits, grouped by topic. Each commit that changes a page carries both languages. The fifth gives agents the pull request description format, so a contributor who drafts a PR with an agent gets the review checklist without asking for it.
Part 1: section structure (
48b789891)difficulty.## <Product>section that introduces the Product and links the mechanism page. Concept pages gains a paragraph on this page.## <Product>section per Product, with its symptoms as###.Part 2: classes and terminology (
922dfb3b6)**Functions** is a Platform Resource that…. A new Documentation terminology section classifies each element: a section root is a Platform Resource, a nested Product is a Product, and a Feature carries its scope. The Overview template, its Functions example, its resources entries, and the Tiered Cache example in Concept pages carry the class.Part 3: cohesion (
d6de1d6de)Part 4: four rules the guide stated two ways (
2ceb1ce77)description. The Components example now usesdescription="Version 1.3.0", as Changelog pages requires.**Bot Manager** now…. That matches the guide's own example.## WAFsection on a page that already expanded WAF is valid.Part 5: the pull request description format
.github/PULL_REQUEST_TEMPLATE.mdreturns to What & why, Type of change, and Author checklist, the format of docs(governance): add governance model, PR checks, and contribution templates #2307 that CONTRIBUTING, GOVERNANCE, and AGENTS.md still described as "the review contract". The checklist rows are the docs(governance): add governance model, PR checks, and contribution templates #2307 rows, word for word. The URL guidance that docs(style-guide): review the EN style guide against the naming catalog (MM-16284) #2561 added becomes a comment on the redirect row.pr.mdat the repository root, title line first.CLAUDE.mdand notAGENTS.md.CLAUDE.mdnow importsAGENTS.mdabove the webkit block, whichwebkit initleaves alone.apps/redirects-massive/src/redirects/, which no longer exists. It now namesapps/docs/redirects/{en,pt-br}/, as CONTRIBUTING does. CONTRIBUTING's pointer to the removed "URL changes and redirects" section now points to the redirect row..gitignoreignores/pr.md, so a drafted description is never committed.Where the facts come from
src/nav/trees/): Live Ingest is nested in Connectors. In 16 Platform Resource trees, the Management parent holds only Pricing and Changelog.buildGuidesHomeinsrc/nav/resolve.tssorts by label withlocaleCompare, andProductGuidesTable.vuerenders name, type, and updated.secure/waf/how-it-works.mdx) and the## WAFsection of Firewall troubleshooting.CLAUDE.md, and an@AGENTS.mdimport bringsAGENTS.mdin.For review
instância de functionis the default for a function instance in Portuguese, in Docs as code and in the Overview mechanism example. Please confirm it.aplicaçãoandfunção. Most Overviews do not state the class yet.docs/mm-16227-glossary-filter-removalremoves it.docs/mm-16248-console-paths. Both branches touchcomponentes.mdx, the Portuguesetroubleshooting.mdx, andguias-multirrecurso.mdx, on different lines. The branch that merges second rebases.How it was checked
state-the-class-of-an-azion-element,declare-a-classe-de-um-elemento-da-azion,connect-each-sentence-to-the-one-before, andligue-cada-frase-a-anterior. The existingavisos-de-versaoanchor also renders, and a new link now targets it.#nested-products,#produtos-aninhados,#mermaid-diagrams,#diagramas-mermaid, and#version-notices.##and###counts, except Punctuation, as noted above.difficulty, "by title", "effort and freshness", "Two modes exist", the version caution, and the Bot Manager description. The only matches left are Changelog pages' own "newest first" order for entries and the rule that bans "close to your users".Type of change
feat)fix) — typo, broken link, wrong informationdocs) — rewrite, expansion, upkeepi18n)refactor/chore) — reviewed by UXE, no content mixed in — Part 5 changes repository files, but it travels with content, so this row is not trueAuthor checklist
type(scope): summary(see GOVERNANCE.md §4)title,description,meta_tags,namespace,permalink,last_reviewedpt-brupdated in this PR or follow-upi18nissue created: — everyenchange has itspt-brtwin in the same commitpnpm build:local(build + frontmatter check) without errors