wso2 / wso2/api-platform

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

Open Beginner friendly
#3,375 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Aspect/API Aspect/Other hackathon Severity/Trivial Type/Bug
Dominant language
Go
Stars
71
Forks
111
Avg merge
1d 14h
Merged PRs (30d)
110

Description

Please select the area the issue is related to

Gateway

Please select the aspect the issue is related to

Aspect/API (API backends, definitions, contracts, interfaces, OpenAPI), Aspect/Other (Anything else which does not match above categories)

Description

The Documentation section in the root README.md (and the matching lists in docs/README.md and gateway/README.md) still links to docs/gateway/ and docs/ai-gateway/.

Those trees were deleted in f515e8af7 ("Remove unnecessary docs"). The CLI quick start link still works; Gateway, Gateway Quick Start, AI Gateway, AI Gateway LLM Quick Start, and AI Gateway MCP Quick Start all 404.

The live replacements are:

  • 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
Steps to Reproduce
  1. Open https://github.com/wso2/api-platform/blob/main/README.md
  2. Click Gateway Documentation, Gateway Quick Start, AI Gateway Documentation, AI Gateway LLM Quick Start, or AI Gateway MCP Quick Start
  3. Observe GitHub 404
Severity Level of the Issue

Severity/Trivial (Cosmetic issues. Can be fixed in future releases)

Environment Details (with versions)

N/A

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Update the documentation links in README.md, docs/README.md, and gateway/README.md, using the replacement paths listed in the issue. Start by checking the affected links in those three files, then verify that Gateway, quick-start, and AI Gateway destinations no longer return 404.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
90/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.