Skip to content

Commit d37ff1f

Browse files
authored
Initial commit
0 parents  commit d37ff1f

35 files changed

Lines changed: 2020 additions & 0 deletions

‎.mintignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Mintlify automatically ignores these files and directories:
2+
# .git, .github, .claude, .agents, .idea, node_modules,
3+
# README.md, LICENSE.md, CHANGELOG.md, CONTRIBUTING.md
4+
5+
# Draft content
6+
drafts/
7+
*.draft.mdx

‎AGENTS.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
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+
- Run `mint dev` to preview locally
13+
- Run `mint broken-links` to check links
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 */}

‎CONTRIBUTING.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
> **Customize this file**: Tailor this template to your project by noting specific contribution types you're looking for, adding a Code of Conduct, or adjusting the writing guidelines to match your style.
2+
3+
# Contribute to the documentation
4+
5+
Thank you for your interest in contributing to our documentation! This guide will help you get started.
6+
7+
## How to contribute
8+
9+
### Option 1: Edit directly on GitHub
10+
11+
1. Navigate to the page you want to edit
12+
2. Click the "Edit this file" button (the pencil icon)
13+
3. Make your changes and submit a pull request
14+
15+
### Option 2: Local development
16+
17+
1. Fork and clone this repository
18+
2. Install the Mintlify CLI: `npm i -g mint`
19+
3. Create a branch for your changes
20+
4. Make changes
21+
5. Navigate to the docs directory and run `mint dev`
22+
6. Preview your changes at `http://localhost:3000`
23+
7. Commit your changes and submit a pull request
24+
25+
For more details on local development, see our [development guide](development.mdx).
26+
27+
## Writing guidelines
28+
29+
- **Use active voice**: "Run the command" not "The command should be run"
30+
- **Address the reader directly**: Use "you" instead of "the user"
31+
- **Keep sentences concise**: Aim for one idea per sentence
32+
- **Lead with the goal**: Start instructions with what the user wants to accomplish
33+
- **Use consistent terminology**: Don't alternate between synonyms for the same concept
34+
- **Include examples**: Show, don't just tell

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Mintlify
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Mintlify Starter Kit
2+
3+
Use the starter kit to get your docs deployed and ready to customize.
4+
5+
Click the green **Use this template** button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with
6+
7+
- Guide pages
8+
- Navigation
9+
- Customizations
10+
- API reference pages
11+
- Use of popular components
12+
13+
**[Follow the full quickstart guide](https://starter.mintlify.com/quickstart)**
14+
15+
## AI-assisted writing
16+
17+
Set up your AI coding tool to work with Mintlify:
18+
19+
```bash
20+
npx skills add https://mintlify.com/docs
21+
```
22+
23+
This command installs Mintlify's documentation skill for your configured AI tools like Claude Code, Cursor, Windsurf, and others. The skill includes component reference, writing standards, and workflow guidance.
24+
25+
See the [AI tools guides](/ai-tools) for tool-specific setup.
26+
27+
## Development
28+
29+
Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command:
30+
31+
```
32+
npm i -g mint
33+
```
34+
35+
Run the following command at the root of your documentation, where your `docs.json` is located:
36+
37+
```
38+
mint dev
39+
```
40+
41+
View your local preview at `http://localhost:3000`.
42+
43+
## Publishing changes
44+
45+
Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.
46+
47+
## Need help?
48+
49+
### Troubleshooting
50+
51+
- If your dev environment isn't running: Run `mint update` to ensure you have the most recent version of the CLI.
52+
- If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.
53+
54+
### Resources
55+
- [Mintlify documentation](https://mintlify.com/docs)

‎agent-ready/contextual.mdx‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
title: 'Contextual menu'
3+
description: 'Give readers one-click access to AI tools and integrations'
4+
icon: 'bolt'
5+
---
6+
7+
The contextual toolbar is a floating action bar that appears on every page of your docs. It lets readers instantly copy page content, open it in an AI assistant, or add your docs as an MCP server — without leaving the page.
8+
9+
Configure it in `docs.json` under `contextual.options`:
10+
11+
```json docs.json
12+
{
13+
"contextual": {
14+
"options": ["copy", "view", "claude", "chatgpt", "mcp", "cursor", "vscode"]
15+
}
16+
}
17+
```
18+
19+
## Available options
20+
21+
### Content actions
22+
23+
| Option | Description |
24+
|--------|-------------|
25+
| `copy` | Copies the page as Markdown to the clipboard |
26+
| `view` | Opens the raw Markdown version of the page (`.md` URL) |
27+
28+
### AI assistants
29+
30+
| Option | Description |
31+
|--------|-------------|
32+
| `claude` | Opens the page in Claude |
33+
| `chatgpt` | Opens the page in ChatGPT |
34+
| `perplexity` | Opens the page in Perplexity |
35+
| `grok` | Opens the page in Grok |
36+
| `aistudio` | Opens the page in Google AI Studio |
37+
38+
### Editor integrations
39+
40+
| Option | Description |
41+
|--------|-------------|
42+
| `cursor` | Adds the page to Cursor's context |
43+
| `vscode` | Adds the page to VS Code Copilot |
44+
| `windsurf` | Adds the page to Windsurf's Cascade |
45+
| `devin` | Opens the page in Devin |
46+
47+
### MCP
48+
49+
| Option | Description |
50+
|--------|-------------|
51+
| `mcp` | Shows instructions for using your docs as an MCP server |
52+
| `add-mcp` | Provides a one-click prompt to add your docs MCP server to an AI tool |
53+
54+
<Tip>
55+
The `mcp` and `add-mcp` options are especially powerful — they let developers connect your entire docs site to any MCP-compatible AI assistant, so it can answer questions about your product directly.
56+
</Tip>
57+
58+
## Custom options
59+
60+
You can add custom entries to the toolbar with a title, description, icon, and link. The `href` supports dynamic placeholders:
61+
62+
| Placeholder | Resolves to |
63+
|-------------|-------------|
64+
| `$page` | The current page's full URL |
65+
| `$path` | The current page's path |
66+
| `$mcp` | Your docs MCP server URL |
67+
68+
```json docs.json
69+
{
70+
"contextual": {
71+
"options": [
72+
"copy",
73+
"claude",
74+
{
75+
"title": "Open issue",
76+
"description": "Report a problem with this page",
77+
"icon": "github",
78+
"href": "https://github.com/your-org/docs/issues/new?title=Issue+on+$path"
79+
}
80+
]
81+
}
82+
}
83+
```
84+
85+
<Note>
86+
The contextual toolbar is only visible on preview and production deployments, not in `mint dev` local preview.
87+
</Note>
88+
89+
## Pairing with Visibility
90+
91+
The toolbar's `copy` and `view` options expose your page's Markdown content directly. If you use the [`Visibility`](/agent-ready/visibility) component, the `for="agents"` blocks will be included in that Markdown — giving AI assistants structured context that human readers don't see.

‎agent-ready/prompt.mdx‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: 'Prompt component'
3+
description: 'Embed shareable AI prompts readers can copy or open in Cursor'
4+
icon: 'robot'
5+
---
6+
7+
The `Prompt` component displays a pre-built AI prompt with one-click actions to copy it to the clipboard or open it directly in Cursor. It's ideal for any docs page where you want to hand readers a ready-to-use prompt.
8+
9+
## Basic usage
10+
11+
<Prompt description="Summarize this API endpoint">
12+
You are a technical writer. Given the following API endpoint documentation, write a one-paragraph summary that explains what the endpoint does, what inputs it requires, and what it returns. Be concise and use plain language.
13+
</Prompt>
14+
15+
```mdx
16+
<Prompt description="Summarize this API endpoint">
17+
You are a technical writer. Given the following API endpoint documentation,
18+
write a one-paragraph summary that explains what the endpoint does, what
19+
inputs it requires, and what it returns. Be concise and use plain language.
20+
</Prompt>
21+
```
22+
23+
## With Cursor integration
24+
25+
Add `actions={["copy", "cursor"]}` to also surface an "Open in Cursor" button. This is especially useful for prompts readers will use in their editor.
26+
27+
<Prompt
28+
description="Generate a typed API client"
29+
icon="code"
30+
actions={["copy", "cursor"]}
31+
>
32+
You are an expert TypeScript developer. Given the following OpenAPI specification, generate a fully-typed API client using native fetch. Include:
33+
- A base client class with configurable baseUrl and auth headers
34+
- One method per endpoint, with typed request parameters and response types
35+
- JSDoc comments on each method
36+
Do not use any third-party HTTP libraries.
37+
</Prompt>
38+
39+
```mdx
40+
<Prompt
41+
description="Generate a typed API client"
42+
icon="code"
43+
actions={["copy", "cursor"]}
44+
>
45+
You are an expert TypeScript developer. Given the following OpenAPI
46+
specification, generate a fully-typed API client using native fetch...
47+
</Prompt>
48+
```
49+
50+
## Props
51+
52+
<ResponseField name="description" type="string" required>
53+
Heading text shown above the prompt content. Supports Markdown.
54+
</ResponseField>
55+
56+
<ResponseField name="children" type="string" required>
57+
The prompt text that gets copied or sent to Cursor.
58+
</ResponseField>
59+
60+
<ResponseField name="actions" type="array">
61+
Which action buttons to show. Options: `"copy"`, `"cursor"`. Defaults to `["copy"]`.
62+
</ResponseField>
63+
64+
<ResponseField name="icon" type="string">
65+
An icon displayed alongside the description. Supports Font Awesome, Lucide, and Tabler icon names, image URLs, or inline SVG.
66+
</ResponseField>
67+
68+
## When to use it
69+
70+
The `Prompt` component works well anywhere you're teaching readers to work with AI:
71+
72+
- **Quickstart guides** — give readers a prompt to generate their first integration
73+
- **API reference pages** — include a prompt for generating client code from the spec
74+
- **Troubleshooting guides** — embed a debugging prompt readers can run against their own error logs
75+
- **Conceptual pages** — add a prompt for exploring the topic further with an AI assistant

0 commit comments

Comments
 (0)