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

  1. Open your docs repository

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

  2. Install Mintlify skills

    In the integrated terminal, run:

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

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

  3. Customize AGENTS.md

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

  4. Start writing

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