Documentation project instructions
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
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 devto preview locally - Run
mint broken-linksto check links
Terminology
- Use “식품 브랜드” or “브랜드” for businesses evaluating Poolix solutions
- Use “크리에이터” for influencer or creator-side users
- Use “솔루션” for Poolix service offerings
- Use “제품 개발” for PRD, sourcing, and sample development stages
- Use “완제품 생산” for commercialization, QC, and delivery stages
- Use “자사몰” instead of generic “쇼핑몰” when referring to a brand-owned store
- Use “공동구매 운영” for creator-led limited-time selling workflows
- Avoid internal classification codes like
[M1],[D1],[P2]in page titles and headings
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
- Write titles and descriptions for real search intent, not internal team terminology
- Make the first section answer the core user question directly
- Prefer question-style H2 headings such as “What is X?” and “Who is it for?”
- Add 2-4 relevant internal links on solution pages when related docs exist
- Keep frontmatter descriptions specific: audience, scope, and outcome in one sentence
- Use descriptive alt text for images; describe the scene, purpose, or information shown
- Keep marketing copy grounded in operational details, deliverables, and constraints
- For Mintlify pages, ensure code blocks have a language label when applicable
Content boundaries
- Document only publicly shareable Poolix offerings, workflows, and decision criteria
- Do not publish internal-only operating notes, pricing logic, or confidential partner terms unless approved
- Mark teaser or pre-launch pages with
noindex: truewhen they are not ready for search discovery - If a page exists mainly for discovery, ensure it still contains actionable detail, not only promotional copy
- Prefer explaining what Poolix does, what it does not do, and what the customer is responsible for