diff --git a/README.md b/README.md index 794df6e7a4..77ea5a5283 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/README.md b/docs/README.md index 7fbd5846aa..fa9915bd1c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 diff --git a/gateway/README.md b/gateway/README.md index b47b054cf5..7f9e0e92aa 100644 --- a/gateway/README.md +++ b/gateway/README.md @@ -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 @@ -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