Introduction

Welcome to Acme Corp‘s Core Platform docs - the main REST API and dashboard behind everything else in this Kitchen Sink example. You’re currently reading 2026-01 docs; the 2025-09 version is still around for anyone mid-migration, under the version switcher up top.

If you have any trouble, reach out at support@kitchen-sink.example.com - that address, like the version badges above, comes from a real writedocs component/variable, not hardcoded text.

This page exists purely to exercise components - the “product” being documented isn’t real. Every code sample, endpoint, and metric below is illustrative.

Four kinds of callouts

A note - background information that’s useful but not critical.

A tip - a suggestion that makes something easier or faster.

A warning - something that could cause a problem if ignored.

A danger callout - reserved for destructive or irreversible actions.

Where to go next

🚀

Quickstart

Get an API key and make your first request in under five minutes.

🔑

Authentication

How API keys, scopes, and token expiry work.

⏱

Rate limits

Per-tier request limits and the headers that report them.

🔌

OpenAPI reference

A fully generated API reference, straight from an OpenAPI spec.

How a request flows through the platform

graph TD A[Client request] --> B{API Gateway} B -->|valid key| C[Rate limiter] B -->|invalid key| D[401 response] C -->|under limit| E[Core service] C -->|over limit| F[429 response] E --> G[(Database)] E --> H[Response]

Flowcharts, sequence diagrams, and state diagrams all render the same way - fence the block as mermaid instead of a language name, and it follows the site’s light/dark toggle automatically.

The math behind rate limiting

The token bucket algorithm backing our rate limiter refills at a constant rate $r$ tokens per second, up to a burst capacity $b$ . A request is allowed when the current token count $t$ satisfies $t \geq 1$ :

t_{n} = \min(b,\ t_{n-1} + r \cdot \Delta t)

See Rate limits for the actual per-tier numbers.

Frequently asked questions

Is this a real API? #

No - every endpoint, response shape, and metric in this fixture is illustrative, meant only to exercise writedocs’ own components and features.

Where's the OpenAPI-generated reference? #

Under the OpenAPI Demo tab, next to Guides and API Reference above - it’s generated entirely from openapi.yaml at build time, not hand-written like the Resources/Errors pages under API Reference.

Why are there two different API reference styles? #

To show both are possible in the same site: API Reference is ordinary hand-written pages organized into dropdowns; OpenAPI Demo is auto-generated, one page per operation, straight from a spec file.

This callout is written once, in snippets/pro-tip.mdx, and imported wherever it’s needed. The word snippets below came from a prop passed at the import site, not hardcoded in this file.