Repository navigation
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
Conversation
…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
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.
Summary
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 architecturepoints 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.ai-agent-third-party-llmpage 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.How to test
cd apps/docs && pnpm lint:navcheck: passes (51 warnings, all existing soft-max row counts).pnpm build:local(Node 26,NODE_USE_SYSTEM_CA=1): passes, including the frontmatter test.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./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./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
docs/mm-16244-triage-orphan-pagesand should merge after it. The use-case pages and the architecture URLs are the same onmain, so if docs(nav): triage the pages outside the navigation (MM-16244) #2593 is squash-merged first, rebase this branch ontomainbefore merging.ai-agent-third-party-llmpage (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.