Skip to content

Contribute a Guide

The Gateway documentation is open for community contributions. If you've connected a tool to the Gateway and it's not documented here, submit a guide.

What makes a good guide

A good integration guide:

  • Works. You've tested it yourself with a real LLM API key.
  • Uses the YOUR_API_KEY and https://llm.[your-region].amazee.ai/v1 placeholders — no hardcoded credentials or region-specific URLs.
  • Follows the structure below.
  • Is written for someone who has the tool installed and just needs to connect it to the Gateway.

Guide template

Copy this and fill it in:

# Use [Tool Name] with amazee.ai

[One sentence: what the tool is and what you can do with amazee.ai + tool.]

## Prerequisites

- [Tool] installed ([link to install docs])
- An amazee.ai API key and endpoint from [my.amazee.io](https://my.amazee.io)

---

## Connect amazee.ai

[Step-by-step setup. Be specific — field names, UI paths, exact values.]

---

## Verify

[How to confirm it's working. A quick test the reader can run.]

---

## Troubleshooting

[2–4 common issues and how to fix them.]

How to submit

  1. Fork amazeeio/docs.amazee.ai
  2. Add your guide to docs/guides/[category]/[tool-name].md
  3. Use coding-agents/ for CLI tools, code editors, and coding agents
  4. Use ai-platforms/ for chat UIs, workflow tools, and self-hosted AI apps
  5. Add your guide to the nav: section in mkdocs.yml
  6. Open a pull request with the title: Add guide: [Tool Name]

Review process

We'll review your PR within a few business days. We may ask for small changes (usually just testing notes or wording). Credits are applied once the guide is merged.

Questions?

Open a GitHub issue or reach out at ai.support@amazee.io.