Skip to content

docs(style-guide): bring the public guide to the platform taxonomy - #2396

Merged
marcus-souza-azion merged 1 commit into
release/new-azion-docsfrom
fix/style-guide-taxonomy-update
Sep 29, 2026
Merged

marcus-souza-azion merged 1 commit into
release/new-azion-docsfrom
fix/style-guide-taxonomy-update

Conversation

@marcus-souza-azion

Copy link
Copy Markdown
Contributor

What & why

Related issue: MM-16039

Apply the four platform terms (Platform, Product, Platform Resource, Feature) and the Solution > Use Case > Reference Architecture content tree to the style guide, in English and Portuguese.

  • Terminology: replace "Name a module as a product" with the resource nomenclature, the four-term table, and the scope of the retired module and add-on terms.
  • Use cases and architecture pages come from the Use Case catalog: title, scenario, products, summary, and components; catalog-first routing against multi-product guides; how to request an entry.
  • Slot 4 is Features; resource-type sections follow the skeleton.
  • Every "distributed network" and "edge node" in examples becomes Azion's distributed infrastructure and data center.
  • Troubleshooting headings carry error strings as plain text, with the rule added to Headings.

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 — the five-field contract is complete on every page; last_reviewed exists on no page in the corpus
  • No legacy "edge-" product names in the copy
  • How-to/tutorial content includes at least one runnable, copy-paste-tested code block — not applicable: style guide pages only
  • Screenshots (if any) have alt text and follow image standards — not applicable: no images
  • Internal links are relative and resolve locally — the links added by the new examples were checked against the permalinks in the checkout, and all 44 pages render on the dev server
  • 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:
  • I ran pnpm build:local (build + frontmatter check) without errors

Apply the four platform terms (Platform, Product, Platform Resource,
Feature) and the Solution > Use Case > Reference Architecture content
tree to the style guide, in English and Portuguese.

- Terminology: replace "Name a module as a product" with the resource
  nomenclature, the four-term table, and the scope of the retired
  module and add-on terms.
- Use cases and architecture pages come from the Use Case catalog:
  title, scenario, products, summary, and components; catalog-first
  routing against multi-product guides; how to request an entry.
- Slot 4 is Features; resource-type sections follow the skeleton.
- Every "distributed network" and "edge node" in examples becomes
  Azion's distributed infrastructure and data center.
- Troubleshooting headings carry error strings as plain text, with
  the rule added to Headings.
@marcus-souza-azion
marcus-souza-azion requested a review from a team as a code owner September 29, 2026 00:33
@marcus-souza-azion
marcus-souza-azion merged commit dbab11d into release/new-azion-docs Sep 29, 2026
5 of 8 checks passed
@marcus-souza-azion
marcus-souza-azion deleted the fix/style-guide-taxonomy-update branch September 29, 2026 00:39
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.

1 participant