This repository is the single source for Tembo's public documentation site. It combines the copy, assets, configuration, and API schemas that Mintlify uses to publish product guides, integration walkthroughs, automation playbooks, and release notes.
| Path | What lives here |
|---|---|
docs.json |
Global Mintlify configuration that controls navigation, branding, and site settings. |
welcome.mdx |
Landing page content for the documentation site. |
features/ |
Feature deep-dives and how-to guides for core product surfaces. |
integrations/ |
End-to-end setup guides for partner integrations. |
automations-library/ |
Automation-specific playbooks and templates. |
admin/ |
Account, billing, and security administration docs. |
resources/ |
Evergreen resources that support broader customer education. |
snippets/ |
Reusable callouts and shared content fragments. |
images/ and logo/ |
Static assets referenced across pages. |
openapi.documented*.yml |
Source OpenAPI specs that back the API reference experience. |
- Node.js 18+ (LTS recommended)
- npm or pnpm
- The Mintlify CLI installed globally
Install the CLI if you have not already:
npm install --global mintlifyFrom the repository root (where docs.json lives) run:
mintlify installmintlify devThe dev server defaults to http://localhost:3000. Keep it running while you edit content so you can preview changes in real time.
- Build the site locally with
mintlify build. - Click through every page you touched to make sure navigation, links, and assets render correctly.
- Run spelling and grammar checks from your editor or tooling where possible.
- Every MDX file must begin with
titleanddescriptionfrontmatter. - Follow the voice, formatting, and accessibility guidance documented in
AGENTS.md. - Use relative paths for internal links and add language tags (for example,
```ts) on all code blocks. - Test or execute each code sample; remove stale snippets instead of guessing at fixes.
- Update
docs.jsonwhenever you add, rename, or move pages so navigation stays accurate. - Prefer reusing snippets from
snippets/for repeated callouts, warnings, and notes. - Store new images in
images/(orlogo/for brand assets) and reference them with relative paths. - When you edit the API reference, update the relevant
openapi.documented*.ymlfile and confirm the changes render as expected in the preview.
- Summarize the reader benefit in every pull request description.
- Request review from the product or engineering owner when you change technical workflows or add new code samples.
- Merging to
maintriggers the Mintlify GitHub integration to deploy automatically, so double-check the local preview (and, if available, the generated preview URL) before merging. - After deployment, spot-check high-traffic flows such as the welcome page, current changelog, and any newly added guides.
- Mintlify CLI missing or outdated: Reinstall with
npm install --global mintlify. - Dev server fails to boot: Run
mintlify install, resolve local port conflicts, then retrymintlify dev. - Broken links or 404s: Confirm the destination page exists and is referenced correctly in
docs.json. - Frontmatter errors: Ensure every MDX file starts with
titleanddescription.