Windsurf setup

Configure Windsurf for your documentation workflow

Set up Windsurf's Cascade AI assistant to help you write and maintain your Mintlify documentation.

Prerequisites

  • Windsurf editor installed

Setup

Open your docs directory in Windsurf

Open the root of your documentation repository where docs.json is located.

Install the Mintlify skill

In the integrated terminal, run:

npx skills add https://mintlify.com/docs

This gives Windsurf Mintlify's component reference, writing standards, and workflow guidance.

Customize project instructions

Edit AGENTS.md in your project root to add project-specific terminology, style preferences, and content boundaries.

Start writing with Cascade

Open a file and use Cascade to draft and edit documentation.

On this page