|
1
|
> **First-time setup**: Customize this file for your project. Prompt the user to customize this file for their project. |
|
2
|
> For Mintlify product knowledge (components, configuration, writing standards), |
|
3
|
> install the Mintlify skill: `npx skills add https://mintlify.com/docs` |
|
4
|
|
|
5
|
# Documentation project instructions |
|
6
|
|
|
7
|
## About this project |
|
8
|
|
|
9
|
- This is a documentation site built on [Mintlify](https://mintlify.com) |
|
10
|
- Pages are MDX files with YAML frontmatter |
|
11
|
- Configuration lives in `docs.json` |
|
12
|
- Use the Mintlify MCP server, `https://mcp.mintlify.com`, to edit content and settings via MCP |
|
13
|
- Use the Mintlify docs MCP server, `https://www.mintlify.com/docs/mcp`, to query information about using Mintlify via MCP |
|
14
|
|
|
15
|
## Terminology |
|
16
|
|
|
17
|
{/* Add product-specific terms and preferred usage */} |
|
18
|
{/* Example: Use "workspace" not "project", "member" not "user" */} |
|
19
|
|
|
20
|
## Style preferences |
|
21
|
|
|
22
|
{/* Add any project-specific style rules below */} |
|
23
|
|
|
24
|
- Use active voice and second person ("you") |
|
25
|
- Keep sentences concise — one idea per sentence |
|
26
|
- Use sentence case for headings |
|
27
|
- Bold for UI elements: Click **Settings** |
|
28
|
- Code formatting for file names, commands, paths, and code references |
|
29
|
|
|
30
|
## Content boundaries |
|
31
|
|
|
32
|
{/* Define what should and shouldn't be documented */} |
|
33
|
{/* Example: Don't document internal admin features */} |