Skip to main content

​
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 npx mintlify dev to preview locally
  • Run npx mintlify broken-links to check links

​
Quick start

npm install          # Install Mintlify CLI
npx mintlify dev     # Preview at localhost:3000
npx mintlify broken-links  # Verify all links

​
Structure

.
├── docs.json              # Navigation, theme, and site config
├── introduction.mdx       # English pages (default language)
├── getting-started.mdx
├── core-concepts/         # Canvas, AI agent, vision engine, workspace memory
├── creating/              # Image/video generation, analysis
├── workspace/             # Projects, assets, skills, team, settings, pricing
├── zh/                    # Chinese translations (mirror English structure)
└── ja/                    # Japanese translations (mirror English structure)
All content exists in 3 languages (en, zh, ja). When adding or editing a page, update all 3 versions and add the page to all 3 language sections in docs.json.

​
Adding a new page

  1. Create the English .mdx file with YAML frontmatter (title, description, icon)
  2. Add the page path to the appropriate group in docs.json under the en language
  3. Create the zh/ and ja/ translated versions
  4. Add those paths to the zh and ja language sections in docs.json
  5. Run npx mintlify broken-links to verify all cross-references

​
Terminology

TermUsage
CanvasThe infinite spatial workspace. Always lowercase except at sentence start.
AI agentThe chat-based creative partner. Not “bot”, “assistant”, or “chatbot”.
Vision engineThe image/video analysis system. Not “analyzer” or “scanner”.
Workspace memoryThe persistent context system. Not “AI memory” or “brain”.
CreditsThe unit of currency for AI generation. Not “tokens” or “points”.
WorkspaceA shared team environment. Not “organization” or “account”.
ProjectA single creative work containing a canvas and chat history.
GenerationThe act of AI creating an image, video, or audio. Not “creation” or “output” as a noun for the process.
Reference videoVideo generated with reference images for visual consistency. Not “image-to-video” or “multi-shot”.
Asset libraryThe workspace-level media hub for uploaded files. Not “media library” or “file manager”.
Auto ClassifyAI-powered asset tagging through visual similarity clustering. Not “auto-tag” or “smart tags”.
SkillA reusable prompt template invoked via /slash command. Not “macro”, “shortcut”, or “preset”.
TagA label for organizing assets. Not “folder”, “category”, or “group” (tag groups are a separate concept).

​
Translation conventions

EnglishChinese (zh)Japanese (ja)
AI agentAI 助手AIエージェント
Canvas画布キャンバス
Vision engine视觉引擎ビジョンエンジン
Workspace memory工作区记忆ワークスペースメモリー
Credits积分クレジット
Asset library素材库アセットライブラリ
Skill技能スキル
Tag标签タグ
Reference video参考视频リファレンス動画
Auto Classify自动分类自動分類
Auto Name自动命名自動ネーミング
Internal links in translations use language prefix: /zh/creating/..., /ja/creating/...

​
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

​
Mintlify components

Use these MDX components where appropriate:
  • <Steps> / <Step title="..."> — Sequential workflows
  • <Tabs> / <Tab title="..."> — Tabbed content (e.g., annual vs monthly pricing)
  • <Tip> — Helpful advice
  • <Note> — Important context
  • <Warning> — Caution about credit costs or destructive actions
  • <Accordion title="..."> — Collapsible FAQ items
  • <Card title="..." icon="..." href="..."> — Navigation cards
  • <Columns cols={N}> — Multi-column layout for cards

​
Syncing with the product

  • Product codebase: ~/repo/github.com/talkcut/talkcut
  • Sync docs by reading product codebase for user-facing features — never expose implementation details
  • Check lib/ai/tools/ for current AI capabilities (tool names, parameters)
  • Check lib/credits/constants.ts for current credit costs
  • Check components/assets/ for asset management UI behavior