Restructure next into a job-oriented nav, moving 56 pages with redirects and repointed links - #435
Open
veejask-41 wants to merge 2 commits into
Open
Restructure next into a job-oriented nav, moving 56 pages with redirects and repointed links#435veejask-41 wants to merge 2 commits into
veejask-41 wants to merge 2 commits into
Conversation
…cts and repointed links
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (6)
📝 WalkthroughWalkthroughThe PR reorganizes AI Gateway documentation paths. It updates page metadata, internal links, navigation, redirects, standalone indexes, and image references. It also renames the MCP quick-start page and removes its introductory video. ChangesAI Gateway documentation restructure
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related issues
Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 9
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/ai-gateway/next/control-content/execution-order.md`:
- Line 83: Shorten the alt text for the image in the execution-order
documentation, and apply the same change to the other image at the corresponding
location. Keep each alt text at or below 155 characters while preserving the
detailed explanation in the surrounding text.
In `@en/docs/ai-gateway/next/control-content/overview.md`:
- Around line 17-19: Revise one of the two consecutive sentences beginning with
“Guardrails” in the overview content, while preserving both sentences’ meaning
and the existing links and documentation style.
In `@en/docs/ai-gateway/next/mcp-proxy/create-an-mcp-proxy.md`:
- Line 17: Update the changed Markdown heading from “## Quick Start” to sentence
case, “## Quick start,” while preserving the existing heading level and content.
In `@en/docs/ai-gateway/next/reference/management-api/llm-provider-management.md`:
- Around line 4-5: Update the Management API index entry in README.md from the
obsolete gateway-controller-management-api path to
reference/management-api/overview.md, while leaving the surrounding navigation
entries unchanged.
In `@en/docs/ai-gateway/next/run-the-gateway/configuration.md`:
- Line 95: Update the documentation sentence to remove spaces around the em
dash, changing “Secrets — see” to “Secrets—see”. Also update both “Artifact
Templating” links at the referenced locations to use
../../../api-gateway/next/setup/artifact-templating.md.
In `@en/docs/ai-gateway/next/run-the-gateway/immutable-gateway.md`:
- Line 82: Update the Gateway Artifact Templating reference in
immutable-gateway.md to use the next-version setup/artifact-templating.md link
instead of the 1.1.0 path, leaving the surrounding templating guidance
unchanged.
In
`@en/docs/ai-gateway/next/run-the-gateway/sizing-and-performance/ai-gateway-runtime-with-four-cpus.md`:
- Line 29: Shorten the alt text for the throughput and average-response-time
charts in ai-gateway-runtime-with-four-cpus.md (lines 29 and 41) and
ai-gateway-runtime-with-two-cpus.md (lines 29 and 40) to sentence-case
descriptions of the chart type, metric, and runtime size, each no longer than
155 characters. In overview.md (line 37), shorten the deployment architecture
alt text to 155 characters or fewer and omit instance details covered by the
table.
In `@en/mkdocs.yml`:
- Around line 1444-1500: Extend the existing “AI Gateway revamp phase 1:
job-oriented nav” comment above the redirect mappings to explicitly note that
all redirects containing the literal “next” path segment must be updated when
that version is released, preventing legacy links from returning 404.
- Around line 679-690: Remove the duplicate navigation entries for the nine
ai-and-mcp guide pages from either the nested “Guides” section near “Configure
AI Coding Assistants” or the top-level “Guides” section, keeping each page
listed exactly once. Preserve the existing navigation hierarchy and retain all
nine unique guide links.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 418b856c-5f4a-4243-9d37-20ce3409921c
📒 Files selected for processing (65)
en/docs/ai-gateway/next/README.mden/docs/ai-gateway/next/connect-llm-providers/configure-aws-bedrock-provider.mden/docs/ai-gateway/next/connect-llm-providers/llm-templates.mden/docs/ai-gateway/next/control-access/secure-the-management-api.mden/docs/ai-gateway/next/control-content/aws-bedrock-guardrail.mden/docs/ai-gateway/next/control-content/azure-content-safety.mden/docs/ai-gateway/next/control-content/content-length.mden/docs/ai-gateway/next/control-content/execution-order.mden/docs/ai-gateway/next/control-content/json-schema.mden/docs/ai-gateway/next/control-content/overview.mden/docs/ai-gateway/next/control-content/pii-masking-regex.mden/docs/ai-gateway/next/control-content/prompt-decorator.mden/docs/ai-gateway/next/control-content/prompt-template.mden/docs/ai-gateway/next/control-content/regex.mden/docs/ai-gateway/next/control-content/semantic-prompt-guard.mden/docs/ai-gateway/next/control-content/sentence-count.mden/docs/ai-gateway/next/control-content/url.mden/docs/ai-gateway/next/control-content/word-count.mden/docs/ai-gateway/next/control-cost-and-traffic/model-round-robin.mden/docs/ai-gateway/next/control-cost-and-traffic/model-weighted-round-robin.mden/docs/ai-gateway/next/control-cost-and-traffic/semantic-caching.mden/docs/ai-gateway/next/control-cost-and-traffic/timeouts.mden/docs/ai-gateway/next/expose-llms/multi-provider-routing.mden/docs/ai-gateway/next/expose-llms/streaming-responses.mden/docs/ai-gateway/next/mcp-proxy/create-an-mcp-proxy.mden/docs/ai-gateway/next/mcp-proxy/mcp-acl-list.mden/docs/ai-gateway/next/mcp-proxy/mcp-authentication.mden/docs/ai-gateway/next/mcp-proxy/mcp-authorization.mden/docs/ai-gateway/next/mcp-proxy/mcp-rewrite.mden/docs/ai-gateway/next/monitor-traffic/analytics-header-filter.mden/docs/ai-gateway/next/monitor-traffic/logging.mden/docs/ai-gateway/next/monitor-traffic/moesif-analytics.mden/docs/ai-gateway/next/monitor-traffic/tracing.mden/docs/ai-gateway/next/overview.mden/docs/ai-gateway/next/quick-start-guide.mden/docs/ai-gateway/next/reference/management-api/certificate-management.mden/docs/ai-gateway/next/reference/management-api/llm-provider-management.mden/docs/ai-gateway/next/reference/management-api/llm-provider-template-management.mden/docs/ai-gateway/next/reference/management-api/llm-proxy-management.mden/docs/ai-gateway/next/reference/management-api/mcp-proxy-management.mden/docs/ai-gateway/next/reference/management-api/overview.mden/docs/ai-gateway/next/reference/management-api/schemas.mden/docs/ai-gateway/next/reference/management-api/secrets-management.mden/docs/ai-gateway/next/run-the-gateway/configuration.mden/docs/ai-gateway/next/run-the-gateway/database-setup.mden/docs/ai-gateway/next/run-the-gateway/immutable-gateway.mden/docs/ai-gateway/next/run-the-gateway/kubernetes/gateway-operator.mden/docs/ai-gateway/next/run-the-gateway/kubernetes/kubernetes-standalone.mden/docs/ai-gateway/next/run-the-gateway/kubernetes/overview.mden/docs/ai-gateway/next/run-the-gateway/production-deployment/ai-workload-tuning.mden/docs/ai-gateway/next/run-the-gateway/production-deployment/control-plane-connection.mden/docs/ai-gateway/next/run-the-gateway/production-deployment/database-configuration.mden/docs/ai-gateway/next/run-the-gateway/production-deployment/deploy-and-verify.mden/docs/ai-gateway/next/run-the-gateway/production-deployment/overview.mden/docs/ai-gateway/next/run-the-gateway/production-deployment/resources-and-scaling.mden/docs/ai-gateway/next/run-the-gateway/production-deployment/security-hardening.mden/docs/ai-gateway/next/run-the-gateway/sizing-and-performance/ai-gateway-runtime-with-four-cpus.mden/docs/ai-gateway/next/run-the-gateway/sizing-and-performance/ai-gateway-runtime-with-two-cpus.mden/docs/ai-gateway/next/run-the-gateway/sizing-and-performance/overview.mden/docs/ai-workspace/1.0.0/policies/overview.mden/docs/ai-workspace/next/policies/overview.mden/docs/ai-workspace/next/sync-gateway-created-artifacts.mden/docs/llms.txten/docs/next/index.mden/mkdocs.yml
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
1 participant
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
Second phase of the AI Gateway docs revamp: applies the job-oriented navigation from #423 to
en/docs/ai-gateway/next/, moving every page into a directory that matches its new nav position,with a redirect for each move and every inbound link repointed.
Level-2 nav no longer names components.
LLM Proxy,Resiliency,Observability,Analytics,Setup,Deployment,PerformanceandManagement APIare gone, replaced by the eleven jobsections the issue specifies. Guardrails are out from under
LLM Proxyand now sit inControl Content at level 2, which is what our own Overview already implied by saying they apply
at three levels.
Refs #423
What changed
llm-proxy/,setup/,deployment/,performance/,observability/,analytics/,resiliency/andgateway-controller-management-api/. Nothing is orphaned — the only file not in nav isREADME.md, which was already out of nav.Deployment > Deployment Modes > Kubernetes > Overviewand its two siblings sat at depth 4. Collapsing toRun the Gateway > Kubernetesfixes all three.pre-existing
deployment-modes/redirects whose targets this phase moves — those would havesilently started pointing at deleted pages, so they are repointed at their final destinations
rather than left to chain.
gateway-controller-management-api/authentication.mdbecomescontrol-access/secure-the-management-api.mdsection, not under AI Gateway at all. It now sits in Connect LLM Providers.
cheapest-first, so expanding it opens on Guardrails Overview rather than dropping the reader
into AWS Bedrock Guardrail — the heaviest page in the set.
create-an-mcp-proxy.md. After Merge the two quick starts into one tabbed, video-free page and retit… #424 there is exactly onequick start in this doc set, so a second file with that name under a Create an MCP Proxy nav
label was actively misleading.
llms.txt: 37 of the 39 AI Gateway URLs rewritten to the new paths.Two changes go beyond a path substitution, both deliberate:
api-gateway/next/policies/ with ../../../../../ where the tree only goes three levels deep.
The move changes the arithmetic anyway, so these are corrected in passing. This is where the
3-warning reduction comes from.
Verification
Seven unresolved, all pre-existing or documented — five dead directory links in README.md
(two predate this PR) and the two artifact-templating.md links.
anchors, so this needed doing separately — it covers the 251 same-directory schemas.md#… links
in the management API reference, which is the largest single link cluster in the tree.
links: 11 performance charts and 2 policy-execution diagrams would otherwise have broken.
forward the URL fragment, so deep links with anchors land on the right section.
four deep.
ai-gateway/ are three one-line link repoints in ai-workspace/ pages that pointed into the
moved tree.
Action required at release time
en/mkdocs.yml carries 33 redirects mapping version-less ai-gateway/ onto
ai-gateway/1.1.0/. This PR points 112 canonical_url/md_url fields and 39 llms.txt
URLs at version-less new paths, which no released version serves yet. That follows the
frontmatter convention the revamp plan mandates and is consistent across all 56 pages, but it means
those 33 redirects must be repointed when next becomes a release, or those URLs will 404.
Nothing in this PR can resolve that.