Tyk Documentation

This repository is the source of the official Tyk documentation. The docs cover Tyk Gateway (open source), Tyk Dashboard, the Developer Portal, MCP Gateway, Tyk AI Studio and Tyk Cloud. The site is built with Mintlify.

Read the Docs

• Tyk documentation
• Tyk Open Source Gateway quick start
• Tyk Self-Managed quick start
• Tyk Cloud: create an account
• Release notes

For AI Assistants and Agents

• llms.txt lists the docs pages. llms-full.txt contains the full text.
• Every page is also available as Markdown. Add .md to the page URL.
• The docs MCP server is at https://tyk.io/docs/mcp. Use it to search the docs from an MCP client.

Versions

The main branch is the next release. It deploys to the Nightly docs. Each release-5.x branch holds the docs for that release. Versions 5.8 and later come from this repository. Versions 5.7 and earlier come from the archived tyk-docs-hugo repository.

Run the Docs Locally

You need Node.js and Git.

1. Install the Mintlify CLI:

   npm i -g mint

2. Clone the repository. If you are an external contributor, clone your fork.

   git clone https://github.com/TykTechnologies/tyk-docs.git
   cd tyk-docs

3. Start the preview server:

   mint dev

4. Open http://localhost:3000 in your browser.

Check Your Changes

Run the same validation as CI before you open a pull request. You need Python 3.

pip install requests pyyaml
python3 scripts/validate_mintlify_docs.py . --validate-redirects --verbose

The script finds broken internal links, missing images and redirect problems.

Contribute

We welcome contributions.

1. Create a branch from main.
2. Edit or add .mdx pages. If you add a page, add it to the navigation in docs.json.
3. Open a pull request against main.

For the full workflow, see the contribution guide.

Report a Problem

• Docs error: open an issue in this repository.
• Product question: ask on the Tyk Community Forum.
• Commercial support: see Tyk support.

License

The Mozilla Public License 2.0 applies to this repository.