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

  • 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

Terminology

Use these terms consistently across all docs:

Key flows

AI Actor creation (4 steps): Actor → Purpose → Insights → Reports Create Meeting (3 steps): Choose Variant → Meeting Configuration → Select Participants

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, Click Create Meeting
  • Code formatting for file names, commands, paths, and code references
  • Write for HR business users — avoid technical jargon, explain concepts simply
  • Use step-by-step instructions with screenshots wherever possible
  • Use <Frame caption="..."> for screenshots and images stored in /images/

Content boundaries

  • Target audience: HR teams, recruiters, hiring managers (not engineers)
  • Focus on practical “how to do it” over technical architecture
  • Don’t document internal admin features or backend implementation details
  • Keep setup guides (Google Workspace, Twilio, OpenAI) approachable — assume the reader has admin access but is not a developer