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

# AGENTS

# AGENTS

## Project Overview

This repository hosts the Mintlify documentation site for **Overcut.ai**. Content is written in MDX and organized under `docs/` for product documentation and `blog/` for blog posts. Navigation, theming, and redirects are configured in `docs.json`.

## Repository Structure

* `docs/`: main documentation content. Subfolders by group: `get-started/`, `concepts/`, `quick-starts/`, `use-cases/`, `reference/`, `integrations/`, `repositories/`, `how-to/`.
* `blog/`: blog landing page and post MDX files.
* `snippets/`: reusable JSX/MDX snippets (e.g., blog cards, post metadata list).
* `docs.json`: Mintlify configuration (navigation tabs, groups, redirects, theme, SEO).
* `.vale.ini` and `styles/`: Vale linting configuration and vocabulary/style rules.
* `images/`, `static/`, `logo/`: media and static assets.
* `.claude/skills/`: authoring and review skills for this repo. See below.

## Authoring guidance (skills, on demand)

Detailed guidance lives in skills under `.claude/skills/`. Invoke the relevant skill when the task matches; do not duplicate this guidance into AGENTS.md.

| Skill                | Use when                                                                                                               |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `doc-style`          | Writing or editing prose in any MDX file (voice, tone, punctuation rules, no em dashes, customer-vs-internal balance). |
| `doc-page-structure` | Creating a new MDX page or restructuring one (frontmatter, titles, page-length, MDX components, cross-references).     |
| `doc-navigation`     | Adding, moving, or removing pages, or editing `docs.json` (group purposes, redirects, page placement).                 |
| `review-doc-pr`      | Reviewing a docs PR for customer value and content quality.                                                            |
| `review-open-prs`    | Triaging the open PR queue.                                                                                            |

## Critical Rules

* **Never use em dashes (`—`) in MDX content.** See `doc-style` for replacements.
* Verify documented product behavior against the product source at `/Users/yuvalhazaz/projects/overcut-ai.git/overcut` before publishing. Don't paraphrase or invent UI strings.
* Do not remove or rename pages referenced in `docs.json` without updating navigation and adding a redirect.
* Do not place secrets or credentials in documentation content.
* Do not expose internal implementation names (React components, GraphQL fields, file paths from the product source) in customer-facing docs.

## Common Tasks

* **Add a new documentation page**: create the MDX file under the right `docs/<group>/` folder, add it to the matching group in `docs.json`, fill in frontmatter. See `doc-page-structure` and `doc-navigation`.
* **Move or rename a page**: update `docs.json` `pages` and add a `redirects` entry. See `doc-navigation`.
* **Fix factually-wrong content**: verify against the product source first, then edit. Prefer minimal targeted fixes to broad rewrites.
* **Review a PR**: invoke `review-doc-pr` or `review-open-prs`.

## Reference Examples

* `docs/welcome.mdx`: landing page with `<CardGroup>` and `<Frame>`.
* `docs/building-blocks.mdx`: multi-section page using `<Steps>`, `<Note>`, `<Tip>`.
* `docs/reference/vault.mdx`: reference page covering one feature surface end-to-end.
* `docs/concepts/multi-project-workspaces.mdx`: concept page explaining a cross-cutting idea with links into references.

## Additional Resources

* Mintlify `docs.json` reference: [https://mintlify.com/docs.json](https://mintlify.com/docs.json)
* Mintlify MDX components: [https://mintlify.com/docs/components](https://mintlify.com/docs/components)
* Vale documentation: [https://vale.sh/docs](https://vale.sh/docs)