> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zapier.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AGENTS

# AI contributing guide — docs.zapier.com

This repository is the source of truth for [docs.zapier.com](https://docs.zapier.com), Zapier's public API and developer documentation. It is a [Mintlify](https://mintlify.com) site; content files are `.mdx`.

## Before you start

This repo includes guided skills that walk you through documentation tasks. **Read and follow the relevant skill before starting work.** Skills handle page-type selection, writing standards, formatting, and contribution mechanics so you do not have to remember them.

The full catalog is at [.cursor/skills/SKILLS-INDEX.md](.cursor/skills/SKILLS-INDEX.md). Build and tooling details are in [CLAUDE.md](CLAUDE.md).

Skills are **universal** (they apply to every section: integrations, SDK, MCP, Powered by Zapier, white-label) and **tool-agnostic** (authored in `.cursor/skills/`, mirrored to `.claude/skills/` via `pnpm run sync-skills`). They live as flat folders, organized by the category tag in each description and the `SKILLS-INDEX`.

## Pick your workflow

| I want to...                                            | Read this skill first                                                                    |
| ------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| Create a new page                                       | [create-new-dev-docs](.cursor/skills/create-new-dev-docs/SKILL.md)                       |
| Update an existing page                                 | [update-existing-dev-docs](.cursor/skills/update-existing-dev-docs/SKILL.md)             |
| Review a draft before merging                           | [review-before-done](.cursor/skills/review-before-done/SKILL.md)                         |
| Turn an engineering change into a docs request          | [request-docs-from-code](.cursor/skills/request-docs-from-code/SKILL.md)                 |
| Handle repo mechanics (add, move, remove, redirect, MR) | [contribute-docs](.cursor/skills/contribute-docs/SKILL.md)                               |
| Decide what kind of page to write                       | [dev-doc-types](.cursor/skills/dev-doc-types/SKILL.md)                                   |
| Create or edit an Agent Skill                           | [create-edit-skills](.cursor/skills/create-edit-skills/SKILL.md)                         |
| Write a Platform release changelog                      | [dev-platform-release-changelog](.cursor/skills/dev-platform-release-changelog/SKILL.md) |

## Writing standards

All content must follow the developer-docs writing standards. Apply these whenever you write or edit a page.

**Key rules (always apply):**

* **Sentence case** for all titles and headings, in every section. No exceptions.
* **No negative contractions** — write "do not", "cannot", "will not" (not "don't", "can't", "won't"). Positive contractions like "you'll" are fine.
* **No em-dashes (—)** — rewrite with a colon, parentheses, commas, or two sentences.
* **No sensory language** — write "check", "review", "go to" (not "see", "look at", "view", "watch").
* **Second person** ("you") for the reader; no marketing hype.
* **One action per step.**

Full detail in the Foundational skills:

| Standard                                               | Skill                                                                            |
| ------------------------------------------------------ | -------------------------------------------------------------------------------- |
| Voice, tone, sentence case, em-dashes, headings, steps | [writing-standards-dev-docs](.cursor/skills/writing-standards-dev-docs/SKILL.md) |
| Sensory language, alt text, link text, inclusive terms | [accessibility-inclusivity](.cursor/skills/accessibility-inclusivity/SKILL.md)   |
| Mintlify components, frontmatter, snippets             | [formatting-guidelines](.cursor/skills/formatting-guidelines/SKILL.md)           |
| Multi-language code examples                           | [code-examples](.cursor/skills/code-examples/SKILL.md)                           |
| Terminology                                            | [glossary-terminology](.cursor/skills/glossary-terminology/SKILL.md)             |

## Choose a page type

Every page is a tutorial, how-to, reference, or explanation. See [dev-doc-types](.cursor/skills/dev-doc-types/SKILL.md) for the decision tree, per-type schema, and the agent-readability layer.

## Choose a page template

Once you know the page type, follow the matching template. Each template skill carries the writing rules plus a starter `.mdx` skeleton in its `assets/` folder.

| Page type | Best for                                                             | Template                                                         |
| --------- | -------------------------------------------------------------------- | ---------------------------------------------------------------- |
| Tutorial  | Learning by building a working example end to end (quick start)      | [template-tutorial](.cursor/skills/template-tutorial/SKILL.md)   |
| How-to    | A competent reader completing one known task, or resolving an error  | [template-how-to](.cursor/skills/template-how-to/SKILL.md)       |
| Concept   | Explaining what something is, how it works, and when to use it       | [template-concept](.cursor/skills/template-concept/SKILL.md)     |
| Reference | Factual look-up: errors, limits, states (not OpenAPI endpoint pages) | [template-reference](.cursor/skills/template-reference/SKILL.md) |

Troubleshooting is not a separate type: error catalogs are reference, fixes are how-tos (the error-handling variant in [template-how-to](.cursor/skills/template-how-to/SKILL.md)).

## Repo essentials

* **Content:** `.mdx` files under `integrations/`, `sdk/`, `mcp/`, `powered-by-zapier/`, `white-label/`, `ai-actions/`.
* **Navigation:** every new page must be added to `docs.json` to appear in the sidebar.
* **Reusable content:** lives in `snippets/` and is imported.
* **Comments:** use JSX comments `{/* */}`, never HTML comments.
* **Generated content:** API reference pages, `snippets/sdk/*`, and the integration checks reference are generated — do not hand-edit. See [.cursor/rules/generated-content-safety.mdc](.cursor/rules/generated-content-safety.mdc).
* **Validation:** `pnpm run dev` to preview, `pnpx mintlify broken-links` to check links.
* **Branching:** create a short-descriptive branch from `main`; MRs deploy a preview and merge to production.
