Fix broken README documentation links after docs/gateway and docs/ai-gateway removal - #3376
Fix broken README documentation links after docs/gateway and docs/ai-gateway removal#3376randilt wants to merge 1 commit into
docs/gateway and docs/ai-gateway removal#3376Conversation
… were removed. Point README entries at the component READMEs and samples that still exist.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (3)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe README files update Gateway, AI Gateway sample, and CLI documentation links. Removed documentation paths are replaced with current repository paths. ChangesDocumentation link alignment
Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk: ⚪ Minimal · up to README links now point to the current Gateway, quick-start, CLI, and AI Gateway sample documentation paths. No merge-readiness risk remains. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Purpose
Root
README.md,docs/README.md, andgateway/README.mdstill pointed atdocs/gateway/anddocs/ai-gateway/. Those trees were deleted inf515e8af7("Remove unnecessary docs"), so every Gateway / AI Gateway doc link 404s.Resolves: #3375
Goals
Point the documentation indexes at files that actually exist in the repo so setup/quick-start links work.
Approach
Retargeted the stale markdown links:
gateway/README.mdgateway/distribution/README.mdsamples/ai-gw-llm-proxy/README.mdsamples/ai-gw-mcp-claude-desktop/README.mddocs/cli/README.md(CLI quick start was already valid)gateway/README.mdpointers that still referenced the deleteddocs/gateway/treeNo UI changes.
User stories
As a new contributor/user, I can click documentation links from the repo README and land on real setup/quick-start guides instead of 404s.
Documentation
This PR is the doc-link fix. No product-doc update beyond the README retargets.
Automation tests
N/A — markdown link updates only
N/A — markdown link updates only
Security checks
Samples
LLM/MCP quick-start links now point at the existing samples (
samples/ai-gw-llm-proxy,samples/ai-gw-mcp-claude-desktop). Samples themselves are unchanged.Related PRs
N/A
Test environment
Manual: verified each updated relative link resolves on disk on macOS. No runtime/JDK/browser testing required.