Skip to main content
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

  • This is a documentation site built on Mintlify
  • Pages are MDX files with YAML frontmatter
  • Configuration lives in docs.json
  • Run mint broken-links to check links
  • The bot itself is ESM + TypeScript (node --import tsx index.ts). Handler discovery uses #load-module — see Module loading and discovery.

​
Terminology

​
Style preferences

  • 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
  • Prefer states.ts / ESM export const wording over legacy states.js / module.exports unless documenting history
  • Prefer typed boundaries (Tables<>, discord.js types) over any — see TypeScript and any
  • strictNullChecks is on in main tsconfig.json (Wave C complete); npm run typecheck must stay green
  • @typescript-eslint/no-explicit-any is an error (Wave D); intentional bags live under types/db/. CI runs typecheck + lint
  • Optional typing polish: Waves F1–F8, G, H, I, J, K, L, M, N, O, P, Q, and R complete — see TypeScript and any. Prefer *Doc / Tables<> on new repo getters; shop entities use *Doc on data + annotated wrapper returns; keep global bags (LooseBag / DocBag) loose
  • New handler state: put domain bags on this.data.<key> (not top-level this.ticket / this.poll). Leave this.virtual for CustomForm bookkeeping. Modal entities store instance fields on this.data; external readers use entity.data.<field>

​
Content boundaries