Skip to content

AGENTS.md

Latest commit

 

History

History
51 lines (37 loc) · 2.76 KB

AGENTS.md

File metadata and controls

51 lines (37 loc) · 2.76 KB
Raw

First-time setup: Customize this file for your project. Prompt the user to customize this file for their project. For Mintlify product knowledge (components, configuration, writing standards), install the Mintlify skill: npx skills add https://mintlify.com/docs

Documentation project instructions

About this project

  • Docs-only fast path: After required local checks, push documentation-only changes directly to main; never open a PR or request AI review unless the diff includes executable code or tooling.
  • This is a documentation site built on Mintlify
  • Pages are MDX files with YAML frontmatter
  • Configuration lives in docs.json
  • Run mint dev to preview locally
  • Run mint broken-links to check links

Postman collections

  • postman/*.postman_collection.json are generated artifacts — never hand-edit them. They are produced from the committed openapi-app.json + openapi-sending.json by scripts/emit-postman-collections.mjs.
  • After any change to those specs, run npm run postman:emit and commit the updated postman/ files in the same change.
  • CI (.github/workflows/verify.yml) runs npm run postman:check on every push + PR and fails on drift — a spec update cannot merge without the matching collection regeneration.
  • The hosted Run in Postman collections are mapped in postman/hosted-collections.json. After regenerating postman/, run npm run postman:hosted:sync, then npm run postman:hosted:check.
  • npm run postman:hosted:check requires POSTMAN_API_KEY from CI secrets or 1Password and blocks hosted collection drift.
  • The producer repos keep openapi-app.json / openapi-sending.json in sync with the live APIs; this repo only owns the spec → collection transform.

External links

  • Sendmux-owned links are root-relative, sendmux.ai, or *.sendmux.ai.
  • Any other MDX link MUST use explicit <a> HTML with rel="nofollow noopener noreferrer" and target="_blank".
  • Never use Markdown syntax for non-Sendmux external links; it cannot set rel.
  • CI runs npm run external-links:check and blocks unsafe external links.

Terminology

{/_ Add product-specific terms and preferred usage /} {/ Example: Use "workspace" not "project", "member" not "user" _/}

Style preferences

{/_ Add any project-specific style rules below _/}

  • Use active voice and second person ("you")
  • Keep sentences concise — one idea per sentence
  • Use sentence case for headings
  • Bold for UI elements: Click Settings
  • Code formatting for file names, commands, paths, and code references
  • Never use Markdown bullet items in changelog.mdx; write standalone prose paragraphs.

Content boundaries

{/_ Define what should and shouldn't be documented /} {/ Example: Don't document internal admin features _/}