Documentation project instructions
About this project
- This is the TalkCut product documentation site built on Mintlify
- Pages are MDX files with YAML frontmatter
- Configuration lives in
docs.json - Run
mint devto preview locally - Run
mint broken-linksto check links
Terminology
| Term | Usage |
|---|---|
| Canvas | The infinite spatial workspace. Always lowercase except at sentence start. |
| AI agent | The chat-based creative partner. Not “bot”, “assistant”, or “chatbot”. |
| Vision engine | The image/video analysis system. Not “analyzer” or “scanner”. |
| Workspace memory | The persistent context system. Not “AI memory” or “brain”. |
| Element | A canvas object with name, type, and reference — used for character/prop/scene tracking. |
| Credits | The unit of currency for AI generation. Not “tokens” or “points”. |
| Workspace | A shared team environment. Not “organization” or “account”. |
| Project | A single creative work containing a canvas and chat history. |
| Generation | The act of AI creating an image, video, or audio. Not “creation” or “output” as a noun for the process. |
| Multi-shot video | Video with consistent characters across shots. Not “elements-to-video” (internal name). |
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
- No marketing language: avoid “powerful”, “seamless”, “robust”, “cutting-edge”
- No filler phrases: avoid “it’s important to note”, “in order to”
- No emojis in content
- Present credit costs as ranges per operation type, not per model
- Use user-friendly descriptions for AI capabilities, not internal model names
Content boundaries
- Document only: End-user features visible in the product UI
- Do not document: Internal architecture, API endpoints, database schemas, model IDs, code patterns
- Do not name: Specific AI model providers or model identifiers (e.g., don’t mention “kling”, “veo”, “gemini” — describe capabilities instead)
- Coming soon: NLE export (AAF/XML for DaVinci/Premiere/FCP) — mention only on pricing page with “coming soon” label
- No developer docs: This site is for end users/creators, not developers or API consumers