A community-maintained collection of integration guides showing how to use Turnkey with popular protocols, frameworks, and ecosystems. Merged examples are published to docs.turnkey.com.
- Clear and focused - A reader can follow it plainly, and understand the integration end to end
- Uses Turnkey meaningfully - The Turnkey integration is clear alongside your own product
- Includes working code - Code snippets should be accurate and generally working. Make sure any additional packages/dependencies are made clear for your example.
Follow the conventions established in the Turnkey Cookbook as a guide for structure, depth, and quality when writing your example.
You may copy examples/template.mdx as your starting point. See examples/README.md for full details on structure and conventions.
Before opening a PR, confirm:
- File is at
examples/your-integration-name.mdx - Frontmatter includes
titleandsidebarTitle - All five content sections are present and filled in
- No real API keys, org IDs, or wallet addresses are in the file
- Code snippets are accurate and follow the guidelines above
- Community Examples table (in this README) is updated with your example
PRs are reviewed by the Turnkey team. We may ask for changes if:
- The MDX doesn't render correctly
- Sensitive values are present in code snippets
- The guide is missing key sections or hard to follow
- The Turnkey integration is unclear or incomplete
We aim to review PRs within a few business days.
This repo is a submodule of the tkhq/docs repository, which powers docs.turnkey.com. Merged examples are reviewed by the Turnkey team and published to the live docs.
| Example | Description | Contributor |
|---|