mirror of
https://gitlab.com/KenanZhu/AutoLibraryManuals.git
synced 2026-11-05 05:35:51 +08:00
40 lines
962 B
Plaintext
40 lines
962 B
Plaintext
---
|
|
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>
|