Docs Map

This page is a cross-reference map for quickly jumping between:

• Guides (how to do a task)
• Reference (exact keys/fields/endpoints)
• Annotated Source (line-by-line implementation)

By task

Run the gateway

• Guide: Run the gateway
• Config + env: Config reference, Environment variables
• Code: CLI wiring, Runtime

Configure upstreams

• Guide: Configure upstreams
• Reference: Config reference, Environment variables
• Code: Config loader/schema

Auth + CORS

• Guide: Auth and CORS
• Reference: Environment variables, Problem+JSON
• Code: Authenticator, Middleware

WebSockets

• Guide: WebSockets limits
• Reference: Config reference, Metrics
• Code: Server, Proxy

Webhooks

• Guide: Webhooks
• Reference: Config reference, Problem+JSON
• Code: Webhook handler, Webhook config

Metrics + observability

• Architecture: Observability
• Reference: Metrics
• Code: Metrics registry, Protocol metrics, Logger

Admin API

• Reference: Admin API
• Code: Runtime admin wiring, CLI admin client

OpenAPI

• Guide: OpenAPI
• Code: OpenAPI CLI, Merge service, Server route

Shadowdiff

• Guide: Shadowdiff
• Tooling: Runner script, Mock upstreams
• Code: Shadowdiff CLI, Diff runner

Smoke checks

• Tooling: Smoke script
• Code: CLI, Server routes

Documentation tooling

• Tooling: Documentation tooling
• Code: Docs generator