mirror of
https://gitlab.com/KenanZhu/AutoLibraryManuals.git
synced 2026-11-05 05:35:51 +08:00
Initial commit
This commit is contained in:
35 files changed
+2020
No files matched your search
@@ -0,0 +1,43 @@
|
||||
---
|
||||
title: "Claude Code setup"
|
||||
description: "Configure Claude Code for your documentation workflow"
|
||||
icon: "asterisk"
|
||||
---
|
||||
|
||||
Set up Claude Code to help you write and maintain your Mintlify documentation.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Active Claude subscription (Pro, Max, or API access)
|
||||
|
||||
## Setup
|
||||
|
||||
<Steps>
|
||||
<Step title="Install Claude Code">
|
||||
```bash
|
||||
npm install -g @anthropic-ai/claude-code
|
||||
```
|
||||
</Step>
|
||||
|
||||
<Step title="Install the Mintlify skill">
|
||||
In your docs directory, run:
|
||||
|
||||
```bash
|
||||
npx skills add https://mintlify.com/docs
|
||||
```
|
||||
|
||||
This gives Claude Code Mintlify's component reference, writing standards,
|
||||
and workflow guidance.
|
||||
</Step>
|
||||
|
||||
<Step title="Customize project instructions">
|
||||
Edit `AGENTS.md` in your project root to add project-specific terminology,
|
||||
style preferences, and content boundaries.
|
||||
</Step>
|
||||
|
||||
<Step title="Start writing with Claude Code">
|
||||
```bash
|
||||
claude
|
||||
```
|
||||
</Step>
|
||||
</Steps>
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: "Cursor setup"
|
||||
description: "Configure Cursor for your documentation workflow"
|
||||
icon: "arrow-pointer"
|
||||
---
|
||||
|
||||
Set up Cursor to help you write and maintain your Mintlify documentation.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Cursor editor installed
|
||||
|
||||
## Setup
|
||||
|
||||
<Steps>
|
||||
<Step title="Open your docs directory in Cursor">
|
||||
Open the root of your documentation repository where `docs.json` is located.
|
||||
</Step>
|
||||
|
||||
<Step title="Install the Mintlify skill">
|
||||
In the integrated terminal, run:
|
||||
|
||||
```bash
|
||||
npx skills add https://mintlify.com/docs
|
||||
```
|
||||
|
||||
This gives Cursor Mintlify's component reference, writing standards,
|
||||
and workflow guidance.
|
||||
</Step>
|
||||
|
||||
<Step title="Customize project instructions">
|
||||
Edit `AGENTS.md` in your project root to add project-specific terminology,
|
||||
style preferences, and content boundaries.
|
||||
</Step>
|
||||
|
||||
<Step title="Start writing with Cursor">
|
||||
Open a file and use Cursor's AI features to draft and edit documentation.
|
||||
</Step>
|
||||
</Steps>
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: "Windsurf setup"
|
||||
description: "Configure Windsurf for your documentation workflow"
|
||||
icon: "water"
|
||||
---
|
||||
|
||||
Set up Windsurf's Cascade AI assistant to help you write and maintain your Mintlify documentation.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Windsurf editor installed
|
||||
|
||||
## Setup
|
||||
|
||||
<Steps>
|
||||
<Step title="Open your docs directory in Windsurf">
|
||||
Open the root of your documentation repository where `docs.json` is located.
|
||||
</Step>
|
||||
|
||||
<Step title="Install the Mintlify skill">
|
||||
In the integrated terminal, run:
|
||||
|
||||
```bash
|
||||
npx skills add https://mintlify.com/docs
|
||||
```
|
||||
|
||||
This gives Windsurf Mintlify's component reference, writing standards,
|
||||
and workflow guidance.
|
||||
</Step>
|
||||
|
||||
<Step title="Customize project instructions">
|
||||
Edit `AGENTS.md` in your project root to add project-specific terminology,
|
||||
style preferences, and content boundaries.
|
||||
</Step>
|
||||
|
||||
<Step title="Start writing with Cascade">
|
||||
Open a file and use Cascade to draft and edit documentation.
|
||||
</Step>
|
||||
</Steps>
|
||||
Reference in new issue
Block a user