Docs · Agents

For AI agents

Entrypoint so agents can discover macrocontent docs, pick the right handbook, and follow stable URLs instead of guessing.

Canonical discovery files

What this product is

macrocontent is a content layer over existing websites. Sites integrate @macrocontent/sdk (+ optional @macrocontent/overlay), mark editable nodes with data-macro-key, and editors change content inline without redeploying the site for every copy change.

Which handbook to open

NameTypeDescription
DevelopersSDK & componentsIntegrate @macrocontent/sdk, build custom components, and wire Vite or layouts. → /developers/
DashboardSites & adminManage websites, team, domains, tokens, activity, webhooks, and site settings. → /dashboard/
StoreBuy & libraryBrowse the component store, claim or purchase, adopt updates, and install on websites. → /store/
EditorsOverlay & contentEdit sites with the macrocontent overlay — primitives, drafts, assets, and publish. → /editors/
PublishersSell & catalogShip store listings, packages, payouts, and a quality handbook for components. → /publishers/
API referenceOpenAPI / SwaggerInteractive Swagger for Management, Content, Store, and Publisher APIs. → /api/

Recommended path (implement a site)

  1. Custom blocks (optional)

  2. Automate via API

    Authentication · Swagger UI · OpenAPI catalog /docs.json · Specs /openapi/index.json (fetch JSON — do not scrape Swagger HTML)

Hard rules (do not invent)

Do

  • Use trailing slashes on docs paths (/developers/quickstart/).
  • Keep locales out of data-macro-key — locale is a save dimension.
  • Prefer primitives for single fields; components for multi-field layouts.
  • Read OpenAPI / API handbook before calling management or content APIs.

Don’t

  • Don’t treat marketing pages as the integration contract.
  • Don’t invent endpoint paths or auth headers.
  • Don’t put secrets or management tokens in frontend macro.config.js.

External discovery (marketing site)

NameTypeDescription
llms.txtmarketinghttps://macrocontent.dev/llms.txt — product overview + pointer here
agent-skillsmarketinghttps://macrocontent.dev/.well-known/agent-skills/index.json
agent-setupdocshttps://docs.macrocontent.dev/agent-setup/prompt.md — Copy prompt installer
api-catalogmarketinghttps://macrocontent.dev/.well-known/api-catalog