Skip to content

feat(fundamentals): rebuild Fundamentals as its own level - #2399

Merged
marcus-souza-azion merged 1 commit into
release/new-azion-docsfrom
fix/new-navigation-1-fundamentals
Oct 1, 2026
Merged

marcus-souza-azion merged 1 commit into
release/new-azion-docsfrom
fix/new-navigation-1-fundamentals

Conversation

@marcus-souza-azion

Copy link
Copy Markdown
Contributor

What & why

Stack 1 of 6. Branch fix/new-navigation-1-fundamentals, based on release/new-azion-docs.

Fundamentals stops being an inline dropdown in the root sidebar and opens its own level, so the pages that explain the platform have a place of their own before the navigation is reorganized around Platform resources (PR 3).

  • The level: Overview, How Azion works, Get started, Management, Billing, Security, Reference and Agent resources. How Azion works, First deploy and HTTP status codes move here. The Organization, Workspace and Usage metering placeholders leave the nav, and Agent resources returns as a dropdown that holds Agent setup and the section's llms.txt.
  • Overview: the Platform resources topology, drawn on the Console's expandable cards. Every card is a resource, and its Products appear when it opens.
  • How Azion works: the request path is a text diagram, so the markdown twin carries it. A table lists the Platform resources on the request path. The use-case list reads from one catalog module of 27 catalogued use cases under five Solutions.
  • New and rewritten pages:
    • Accounts, teams, and users, a new concept page.
    • A Performance group with three how-to pages: Test speed, Minimize downtime and Maintenance mode.
    • Create an account and Migrate to Azion, rewritten as task pages.
    • 21 pages swept to the platform taxonomy.
  • Nav: a new llms row kind resolves to the owning section's llms.txt, and the MDX wrapper policy allows ~/data/<module> copy modules.

**Related issue:**MM-16040
Pages affected: Fundamentals, /documentation/fundamentals/ and its pages (EN and PT); src/components/webkit/PlatformTopology*, UseCaseList.vue, src/data/, src/nav/, scripts/eslint-rules/mdx-policy.mjs. 106 files: 19 added, 87 changed (40 English pages, 38 Portuguese, 28 code and data files).

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)

Author checklist

  • PR title follows type(scope): summary (see GOVERNANCE.md §4)
  • Frontmatter complete: title, description, meta_tags, namespace, permalink, last_reviewed — the first five are on all 76 changed pages; last_reviewed is on no page in the corpus yet
  • No legacy "edge-" product names in the copy
  • How-to/tutorial content includes at least one runnable, copy-paste-tested code block — the three Performance how-tos are Console procedures and carry no code block
  • Screenshots (if any) have alt text and follow image standards — no screenshots added
  • Internal links are relative and resolve locally — not fully checked: pnpm lint:navcheck passes with 42 warnings (44 on the base), and linkcheck was not run
  • If any permalink changed or page moved: redirect added in this PR — three rows per language in cicd/massive-redirect/
  • i18n: pt-br updated
  • I ran pnpm build:local (build + frontmatter check) without errors — not run

…latform resources topology and a Performance group

Fundamentals becomes its own sidebar level. Its overview is redrawn as
the Platform resources topology on the Console's expandable cards, the
request path becomes a text diagram and a table named in the resource
nomenclature, the use-case list reads from one catalog module, and a
Performance group adds three how-to pages.

Squashed from:

- feat(fundamentals): rebuild Fundamentals as its own sidebar level
  Fundamentals stops being an inline dropdown in the root sidebar and opens
  its own level: Overview, How Azion works, Get started, Management, Billing,
  Security, Reference, and Agent resources. Platform keeps the nine resource
  rows and loses the How Azion works page, which moves here together with
  First deploy and the HTTP status codes page (six permalink moves, with
  their rows in cicd/massive-redirect). The Organization, Workspace, Usage
  metering, and Agent resources placeholders leave the nav; Agent resources
  returns as a dropdown holding Agent setup and the section's llms.txt.

  Pages: the Overview is rewritten around an interactive deployment topology
  (a webkit Flow island, src/components/webkit/DeploymentTopology*); How
  Azion works gets a request-path island, a product table keyed by resource,
  and use cases from the catalog; a new concept page, Accounts, teams, and
  users; Create an account and Migrate to Azion rewritten as task pages with
  DocSteps; HTTP status codes retitled; 21 existing pages swept to the
  platform taxonomy, in English and Portuguese.

  Nav: a new `llms` row kind resolves to the owning section's llms.txt, and
  the MDX wrapper policy allows `~/data/<module>` copy modules.

- feat(fundamentals): redraw the overview as the platform resources topology
  The Overview diagram now shows how the platform's resources connect instead
  of one example deployment: no instance names, every card is a resource, a
  product, or a platform feature with its taxonomy class, and the graph has
  two rows. The request row goes Edge DNS, DDoS Protection, and Certificate
  Manager into the workload, then firewall, application, and custom pages
  side by side, WAF on the firewall and Cache on the application, and the
  connector to the origin server or Object Storage. A second row shows what a
  function can call: AI Inference, SQL Database, KV Store. The webkit Flow
  pairs adjacent columns in order and a terminal card sends no line, so the
  connectors draw the true attachments.

  The island is renamed PlatformTopology with its data module, the section
  is "Platform resources topology" (PT "Topologia dos Recursos de
  Plataforma"), and a text twin of the graph sits under the walkthrough in a
  native disclosure wrapper (DocDisclosure), kept in the DOM while closed so
  the markdown twin carries it.

- refactor(fundamentals): replace the request path island with a text diagram
  How Azion works describes the request path with a mermaid fence, rendered
  as a code block like every other fence on the site, so agents reading the
  markdown twin get the diagram as text. The RequestPath island and its data
  module are removed.

- docs(fundamentals): name the request path table by platform resources
  The section is "Platform resources on the request path" (PT "Recursos de
  plataforma no caminho da requisição"): the documentation writes in the
  Platform Resource nomenclature, and the table is already keyed by resource.

- feat(fundamentals): read the use-case list from one catalog module
  "What you can build" on How Azion works renders its lists from
  src/data/use-cases, which carries the 27 catalogued use cases under their
  five Solutions, with `featured` marking the selection the page shows and a
  link only where a page implements the use case. A future Use cases section
  reads the same module, so a changed use case is edited once. The Solution
  headings stay in the MDX so the right rail keeps them.

- feat(fundamentals): add the Performance group with three how-to pages
  Test speed (Edge Pulse and Real-Time Metrics, with a before-and-after
  comparison through the hosts file), Minimize downtime (go live without a
  gap, a backup origin with Load Balancer, stale cache, a custom 503 page),
  and Maintenance mode (a request-phase rule that redirects or serves a
  maintenance page from a bucket, with an exception for your own address),
  in English and Portuguese, sourced from the product references and
  guides they link.

- feat(fundamentals): redraw the topology on the Console's expandable cards
  The Overview diagram takes the Console's workload topology as its model:
  neutral cards with a header (icon, kind, chevron), an identity row, and a
  body that opens in place, each card on its own. The skeleton is Workload,
  then Firewall, Application, and Custom Pages side by side, then Store and
  AI above the Connector, then Origin; the products live inside the card
  they attach to and appear only when it opens, as links to their
  references. The open body holds the requirement tag, those links, and the
  reference link; no paragraph, no field rows, no item tags.

  Card width follows the diagram's container, a quarter of it less the
  flow's padding and gaps, clamped between 132px and the Console's 224px,
  so four columns fill the article at any width and never force a
  horizontal scroll. Connector to Store and AI, the one edge the Flow
  cannot draw, is a data-declared link painted in the Flow's connector
  style and re-measured when a card opens. The "diagram as text"
  disclosure and its wrapper component are removed.

- fix(fundamentals): keep the Connector to Store and AI link on the cards
  The link was measured only when the diagram's container resized, and a card
  animating shut stops resizing the container as soon as a taller column takes
  over while the cards below it keep moving, so the last measurement was taken
  mid-transition. The svg also unmounted after one empty measurement. The svg
  now stays mounted, the two endpoint cards are observed as well, and the end
  of every transition triggers a final measurement that also makes the Flow
  re-measure its own lines.

- docs(fundamentals): write the request path table in the resource nomenclature
  In documentation the taxonomy's nomenclature is the Platform Resource one,
  so the table's Products column becomes Reference, linking each entry to its
  reference page, and every other product mention on How Azion works and on
  the Overview now says what you enable or create on a resource. The four
  catalog categories sentence stays. English and Portuguese.
@marcus-souza-azion
marcus-souza-azion added this pull request to stack #2401 October 1, 2026 16:27
@marcus-souza-azion
marcus-souza-azion merged commit beb713b into release/new-azion-docs Oct 1, 2026
5 of 8 checks passed
@marcus-souza-azion
marcus-souza-azion deleted the fix/new-navigation-1-fundamentals branch October 1, 2026 16:37
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