Find your way through these docs

You do not need to read these docs from beginning to end. Start with the outcome you want, then follow the links for that path. Use the sidebar or browse all documentation when you need to move to another subject.

Choose where to start

Understand what TokenTriage does. Read What is TokenTriage?, then How TokenTriage works. If you are comparing gateways, continue to How TokenTriage compares.

See it work locally. Start with the Quickstart. It does not require an API key. Continue with Your first live request when you are ready to use a provider, then Connect your app.

Add or configure a capability. Open the Build group in the sidebar and choose the subject you need, such as routing, governance, providers, guardrails, caching, or observability. Each section begins with an overview before moving into specific tasks and exact configuration details.

Prepare for production or diagnose a problem. Start with Take it to production. Use Deployment topologies to choose how to run it, Runbooks for operational procedures, and Troubleshooting when something is already failing.

How the docs are grouped

The sidebar follows four stages. These stages describe where you are in the work, not how experienced you are.

• Learn introduces TokenTriage, gets it running locally, and explains the concepts used throughout the docs.
• Build covers the capabilities you can configure, including routing, governance, providers, cost attribution, guardrails, caching, observability, and the dashboard.
• Operate covers SDKs, quality measurement, recipes, deployment, and ongoing production work.
• Reference is where you look up exact commands, fields, defaults, error formats, and migration guidance.

The documentation home always shows the current sections and page counts. It is the best place to browse when you know the subject but not the page name.

The four page types

The label below each page description tells you what kind of page you are reading.

• Tutorial gives you one tested path from start to finish. Follow the steps in order and use the final check to confirm the result.
• How-to guide helps you complete a specific task. It states what you need, gives you the steps, and shows you how to verify the change.
• Explanation builds the mental model behind a feature or behaviour. Read it when you want to understand why something works the way it does.
• Reference lists exact values, options, defaults, or response shapes. Search or scan it for the detail you need.

Conventions that affect what you do

• Commands and output can share one code block. Lines you type start with $; unprefixed lines show output. Copy the command without the $.
• Callouts highlight different kinds of guidance. Key takeaway states the central point, Watch out warns about a common failure, Best practice suggests a useful default, and Note adds optional context.
• Collapsed sections contain optional detail. You can skip them and still complete the main task.

Find an answer quickly

• For an unfamiliar term, use the Glossary.
• For a short question about behaviour, storage, or cost, check the FAQ.
• For a command, configuration field, or default, open the Reference section.
• For unexpected behaviour, use Troubleshooting.
• For an API error response, use Errors & problem+json.

If a page is wrong, missing, or hard to follow, email [email protected]. Include what you were trying to do and where you became stuck.