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

# AGENTS

# Repository Agent Instructions

This repository contains the Mintlify-powered help docs for [Readdy](https://readdy.ai), published at [https://docs.readdy.ai](https://docs.readdy.ai). Pages are authored as `.mdx` files under `features/` and `integrations/`; navigation is configured in `docs.json`.

## Writing or editing help docs

When creating or editing any file under `features/` or `integrations/`, **read and follow** the Readdy help doc writing guide first:

```
.claude/skills/readdy-help-doc/SKILL.md
```

That guide encodes the team's conventions:

* Frontmatter fields and casing (`title`, `description`, `sidebarTitle`)
* Recurring section structure (Before You Start / How It Works / FAQ / Troubleshooting / Need Help?)
* Mintlify component usage (`Steps`, `Frame`, `Info`, `Warning`, `Tip`, `Accordion`, …)
* Image path, naming, and `<Frame>` wrapping rules
* Filename slug and `docs.json` navigation insertion rules
* The standard "Need Help?" footer template

Read the SKILL.md before drafting any new doc or making non-trivial edits. Don't introduce patterns not covered there without checking with the team.

## Local preview

```bash theme={null}
mintlify dev
```

Opens at [http://localhost:3000](http://localhost:3000).

## Branching

* New feature doc: `feat/<slug>-doc`
* Edits to live docs / fixes: `fix/<short-summary>` or `docs/<short-summary>`
* Cross-tool / repo config: `chore/<short-summary>`
* Merge into `main` to deploy via Mintlify (auto-deploys within \~1–3 minutes after push).