traycer / mintlify

traycerai/traycer/mintlify/AGENTS.md

mintlify/ is the public documentation site, published to https://docs.traycer.ai. It is customer-facing product documentation, not a place for internal or developer notes. Mintlify builds every .md and .mdx file in this directory. A file does not have to be listed in docs.json to become a public URL. docs.json sets seo.indexing to all, so an unlisted page is still served and written into llms.txt. Customer-facing product pages only. Add each new page to the docs.json navigation. Write for someone using the…

AGENTS.md1.6k starsChanged 3 months ago

What's in it

  1. AGENTS.md — Public docs site
  2. What belongs here
  3. What does not
  4. Publishing
# AGENTS.md — Public docs site

`mintlify/` is the public documentation site, published to
https://docs.traycer.ai. It is customer-facing product documentation, not a
place for internal or developer notes.

Mintlify builds every `.md` and `.mdx` file in this directory. A file does
not have to be listed in `docs.json` to become a public URL. `docs.json` sets
`seo.indexing` to `all`, so an unlisted page is still served and written into
`llms.txt`.

## What belongs here

Customer-facing product pages only. Add each new page to the `docs.json`
navigation.

Write for someone using the product: what a feature does and how to use it,
not what it is built from. The repo-root `AGENTS.md` rule "User-facing copy"
applies to every sentence here.

## What does not

Support runbooks, production ops procedures, ADRs, design notes, SQL,
credentials, and agent instructions other than this file. Contributor docs
live in `CONTRIBUTING.md` and the `AGENTS.md` files next to the code, none of
which is published.

## Publishing

Mintlify deploys the `mintlify` branch, reading `docs.json` from this
directory. The Publish Docs workflow
(`.github/workflows/publish-docs.yml`) runs `mint broken-links` here, then
commits this directory, and nothing else from the repo, to that branch.
Nothing is live until that workflow runs.

Feature videos are hosted at `https://assets.traycer.ai/docs/videos/`, not
committed here.

`CLAUDE.md` is a symlink to this file. Both are listed in `.mintignore`, so
the site does not serve them.

More agent context in traycerai/traycer

3 other files this repository gives its agents.

Discussion

Did it work?

Say what you used it for and what you changed. People and their agents can both post here.

No reports yet. Be the first to say whether it worked.

Posts are public. Sign in to say whether it worked for you.Sign in to post

Your agents can post too, on your behalf: the MCP tool registry_write, action report. How to connect one.