Skip to content

Fix broken README documentation links after docs/gateway and docs/ai-gateway removal - #3376

Open
randilt wants to merge 1 commit into
wso2:mainfrom
randilt:fix/readme-broken-doc-links
Open

Fix broken README documentation links after docs/gateway and docs/ai-gateway removal#3376
randilt wants to merge 1 commit into
wso2:mainfrom
randilt:fix/readme-broken-doc-links

Conversation

@randilt

@randilt randilt commented Sep 4, 2026

Copy link
Copy Markdown

Purpose

Root README.md, docs/README.md, and gateway/README.md still pointed at docs/gateway/ and docs/ai-gateway/. Those trees were deleted in f515e8af7 ("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 docs → gateway/README.md
  • Gateway quick start → gateway/distribution/README.md
  • AI Gateway LLM quick start → samples/ai-gw-llm-proxy/README.md
  • AI Gateway MCP quick start → samples/ai-gw-mcp-claude-desktop/README.md
  • CLI docs → docs/cli/README.md (CLI quick start was already valid)
  • Dropped the standalone AI Gateway docs link — that tree has no replacement
  • Updated gateway/README.md pointers that still referenced the deleted docs/gateway/ tree

No 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

  • Unit tests
    N/A — markdown link updates only
  • Integration tests
    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.

… were removed.

Point README entries at the component READMEs and samples that still exist.
@coderabbitai

coderabbitai Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: 623fd0aa-d22d-4e88-bd92-86ae8633d3e1

📥 Commits

Reviewing files that changed from the base of the PR and between ac398fe and e85eac0.

📒 Files selected for processing (3)
  • README.md
  • docs/README.md
  • gateway/README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The README files update Gateway, AI Gateway sample, and CLI documentation links. Removed documentation paths are replaced with current repository paths.

Changes

Documentation link alignment

Layer / File(s) Summary
Update documentation links
README.md, docs/README.md, gateway/README.md
The README files replace removed Gateway and AI Gateway paths, point quick starts to current sample and distribution documentation, and add the CLI documentation link.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to e85ea

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)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the primary change: fixing broken README documentation links after documentation directories were removed.
Description check ✅ Passed The description covers the required purpose, goals, approach, user stories, documentation impact, tests, security checks, samples, related PRs, and test environment.
Linked Issues check ✅ Passed The changes satisfy issue #3375 by replacing stale Gateway and AI Gateway links with existing repository paths and removing the unavailable standalone AI Gateway link.
Out of Scope Changes check ✅ Passed All changes are limited to README documentation link updates related to issue #3375. No unrelated code, UI, or sample changes are included.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: Root README documentation links 404 after docs/gateway and docs/ai-gateway removal

1 participant