Skip to content

docs(use-cases): link each Reference Architecture page from its use case (MM-16244) - #2594

Open
bruno-andrade-azion wants to merge 1 commit into
docs/mm-16244-triage-orphan-pagesfrom
docs/mm-16244-link-reference-architectures
Open

bruno-andrade-azion wants to merge 1 commit into
docs/mm-16244-triage-orphan-pagesfrom
docs/mm-16244-link-reference-architectures

Conversation

@bruno-andrade-azion

Copy link
Copy Markdown
Contributor

Summary

  • docs(nav): triage the pages outside the navigation (MM-16244) #2593 turns the 19 Reference Architecture pages into hidden rows: they keep their URL and breadcrumb but leave the menu, the Use Cases hub, and prev/next, so the use-case page becomes the only entry point inside the docs. Only 4 of the 19 were linked from their use case before this PR.
  • Each use-case page now links the Reference Architecture page that the GTM catalog (gtm-definitions/use-cases.md) pairs it with, in en and pt-br. 15 of them build that same design ("This page builds the X"), so one new sentence under the intro of ## Reference architecture points to the architecture page: "For this design on its own, with its diagram, dataflow, and components, refer to X." The link text is the architecture page's own title in each language.
  • Build AI agents gets a sentence of its own. The catalog lists the ai-agent-third-party-llm page for its Tool-calling agent over third-party LLMs, but that page currently documents the Retrieval-augmented assistant over third-party LLMs, so the sentence describes what the page actually shows instead of calling it the same design.
Architecture page Linked from (new in this PR in bold)
Git-driven static website Build and run marketing websites
Server-rendered full-stack application on SQL Database Deploy full-stack applications globally
Single-service API on SQL Database Build REST and GraphQL APIs
Microservices API on Functions Build REST and GraphQL APIs
Strangler façade for legacy applications Modernize a monolithic application without a rewrite
Middleware layer over a legacy origin Modernize a monolithic application without a rewrite
Caching reverse proxy in front of an origin Accelerate websites and APIs with a CDN
Accelerating reverse proxy for dynamic APIs Accelerate websites and APIs with a CDN; Keep an application online when an origin fails
Origin-backed image optimization proxy Optimize images for websites and mobile apps
Retrieval-augmented assistant on platform-hosted models Build and run customer support AI assistants
Retrieval-augmented assistant over third-party LLMs Build and run customer support AI assistants; Build AI agents
Catalog-model inference API Add AI features to existing applications
AI-assisted upload inspection pipeline Screen file uploads for malicious content
Web application and API protection (WAAP) perimeter Protect web applications from OWASP Top 10 and zero-day attacks
API security perimeter Protect public APIs from abuse
Bot-scoring perimeter for authentication flows Block account takeover on login and checkout flows
SIEM-driven firewall mitigation loop Block attackers automatically from SIEM detections
Compliance perimeter with security event retention Prepare regulated web applications for security audits
Live stream ingested on Azion Stream live events to large audiences

How to test

  1. cd apps/docs && pnpm lint:navcheck: passes (51 warnings, all existing soft-max row counts).
  2. pnpm build:local (Node 26, NODE_USE_SYSTEM_CA=1): passes, including the frontmatter test.
  3. From the repository root, node scripts/ci/ratchet.mjs linkcheck: ok linkcheck: 159 links quebrados no build (baseline 221, 62 fewer). None of the 159 come from a use-case page; they are the existing agreements and changelog links.
  4. Open /en/documentation/use-cases/build-and-run-applications/build-and-run-marketing-websites/ and /pt-br/documentacao/casos-de-uso/construir-e-executar-aplicacoes/criar-e-operar-sites-de-marketing/. Under Reference architecture, the sentence after "This page builds the Git-driven static website" links to the Git-driven static website page in the same language.
  5. Open /en/documentation/use-cases/build-and-run-ai-workloads/build-ai-agents/ and confirm the new sentence links to Retrieval-augmented assistant over third-party LLMs.

URL changes and redirects

None. Every link points to an existing permalink, read from the target page's frontmatter.

Notes

  • Stacked on docs(nav): triage the pages outside the navigation (MM-16244) #2593 (MM-16244): this PR targets docs/mm-16244-triage-orphan-pages and should merge after it. The use-case pages and the architecture URLs are the same on main, so if docs(nav): triage the pages outside the navigation (MM-16244) #2593 is squash-merged first, rebase this branch onto main before merging.
  • Catalog follow-up: the catalog points Build AI agents → Tool-calling agent over third-party LLMs to the ai-agent-third-party-llm page (marked "Needs update"), but that page is written for the customer support assistant. A tool-calling agent architecture page, or a catalog update, would let Build AI agents link its own design.
  • No new dependency, and only links were added: no other text on the 32 pages changed.

…ase (MM-16244)

The 19 Reference Architecture pages are hidden rows in the Use Cases
sidebar, so the use-case page is their only entry point inside the docs.
Link each one from the use case the GTM catalog pairs it with, in en and
pt-br: one sentence in the Reference architecture section of the 15
use cases that build the same design, and one in Build AI agents, which
shares the third-party LLM page with the customer support use case.

This branch has not been deployed

No deployments
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.

2 participants