Skip to main content

​
DiagramAI documentation instructions

​
Project

  • This is the public DiagramAI documentation site built with Mintlify.
  • Pages are MDX files with YAML frontmatter.
  • Site configuration and navigation live in docs.json.
  • English source pages live in en/ and are published under /en.
  • Simplified Chinese source pages live in zh/ and are published under /zh.
  • The documentation root path redirects to /en.
  • Keep the English and Chinese navigation and page coverage in sync.
  • If the Mintlify skill is unavailable, install it with npx skills add https://mintlify.com/docs and read its SKILL.md before editing.

​
Product terminology

  • Product name: DiagramAI.
  • Use diagram in English and 图表 in Chinese.
  • Use workspace in English and 工作空间 in Chinese.
  • Use organization in English and 组织 in Chinese.
  • Keep the billing unit as credit or credits in both languages.
  • Use the plan names Free, Pro, and Business.
  • Refer to the embedded editor as the diagrams.net editor in English and diagrams.net 编辑器 in Chinese.

​
Writing style

  • Use active voice and address the reader directly.
  • Keep sentences concise and headings in sentence case.
  • Explain a concept before giving instructions.
  • Use bold for UI labels.
  • Use code formatting for file names, paths, keyboard shortcuts, and technical values.
  • Prefer Mintlify components such as Steps, Card, Columns, Note, Tip, and Warning.
  • Do not use marketing superlatives, decorative emoji, or unsupported claims.
  • Every page must include title and description frontmatter.
  • Internal links must be root-relative and omit .mdx.

​
Content boundaries

  • Document public end-user and organization-administrator workflows only.
  • Do not document internal REST endpoints, database structures, environment variables, service credentials, template-authoring administration, or webhook implementation.
  • Do not claim support for version history, comments, simultaneous multi-user editing, public sharing, unlimited AI generation, or a public API.
  • Treat runtime code, src/lib/billing-catalog.ts, src/lib/credit-units.server.ts, and src/lib/plan-limits.ts as the source of truth for product limits and billing.
  • Link to the product legal pages instead of duplicating legal terms.
  • Use support@eoeok.com for support, privacy, and eligible refund requests.

​
Verification

  • Run mint validate, mint broken-links, and mint a11y.
  • Preview both languages and verify dark mode and mobile navigation.
  • Search for starter-template content, placeholder addresses, unfinished markers, and broken internal links before delivery.