Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
randilt wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ The API Platform covers the complete API lifecycle:

Refer to the documentation for setup guides, component-specific quick starts, and usage details.

- [Gateway Documentation](docs/gateway/README.md)
- [Gateway Quick Start](docs/gateway/quick-start-guide.md)
- [AI Gateway Documentation](docs/ai-gateway/README.md)
- [AI Gateway LLM Quick Start](docs/ai-gateway/llm/quick-start-guide.md)
- [AI Gateway MCP Quick Start](docs/ai-gateway/mcp/quick-start-guide.md)
- [Gateway Documentation](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 Documentation](docs/cli/README.md)
- [CLI Quick Start](docs/cli/quick-start-guide.md)

## Platform Components
Expand Down
9 changes: 4 additions & 5 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,10 @@ Standalone design tool for REST, GraphQL, and AsyncAPI specifications.

## Documentation

- [Gateway](gateway/README.md) — API gateway setup, configuration, and policy management
- [Gateway Quick Start Guide](gateway/quick-start-guide.md) — Download, run, and test the API gateway
- [AI Gateway](ai-gateway/README.md) — Managing and securing AI traffic including LLM APIs and MCP servers
- [AI Gateway LLM Quick Start Guide](ai-gateway/llm/quick-start-guide.md) — Download and run the AI Gateway, then route traffic to LLM providers like OpenAI
- [AI Gateway MCP Quick Start Guide](ai-gateway/mcp/quick-start-guide.md) — Download and run the AI Gateway, then route traffic to MCP servers
- [Gateway](../gateway/README.md) — API gateway setup, configuration, and policy management
- [Gateway Quick Start Guide](../gateway/distribution/README.md) — Download, run, and test the API gateway
- [AI Gateway LLM Quick Start Guide](../samples/ai-gw-llm-proxy/README.md) — Route traffic to LLM providers like OpenAI
- [AI Gateway MCP Quick Start Guide](../samples/ai-gw-mcp-claude-desktop/README.md) — Route traffic to MCP servers
- [CLI](cli/README.md) — Command-line tool for managing the API Platform Gateway Controller
- [REST APIs](rest-apis/) — REST API references for platform components
- [Policies and Guardrails](https://github.com/wso2/gateway-controllers/blob/main/docs/README.md) — Gateway policies and guardrails for API traffic control
Expand Down
4 changes: 2 additions & 2 deletions gateway/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A complete API gateway system consisting of Gateway-Controller (xDS control plane), Router (Envoy Proxy data plane), Policy Engine (request/response processing), and Policy Builder (policy compilation tooling).

For end-user documentation, see [docs/gateway/](../docs/gateway/).
For end-user documentation, see the [Gateway distribution README](distribution/README.md).

## Components

Expand Down Expand Up @@ -68,7 +68,7 @@ password, and rewrite `api-platform.env`).

For the full setup reference — flags (`--force`, `--certs-only`), control-plane
connection, at-rest encryption, and how configuration is delivered — see
[docs/gateway/quick-start-guide.md](../docs/gateway/quick-start-guide.md).
[distribution/README.md](distribution/README.md).

### Test

Expand Down