Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions guides/claude-code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
icon: "asterisk"
---

Claude Code is an agentic command line tool that can help you maintain your documentation. It can write new content, review existing pages, and keep docs up to date.

Check warning on line 7 in guides/claude-code.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/claude-code.mdx#L7

Did you really mean 'agentic'?

You can train Claude Code to understand your documentation standards and workflows by adding a `CLAUDE.md` file to your project and refining it over time.

Expand Down Expand Up @@ -49,6 +49,10 @@
- Check existing patterns for consistency
- Start by making the smallest reasonable changes

## docs.json

- Refer to the [docs.json schema](https://mintlify.com/docs.json) when building the docs.json file and site navigation

## Frontmatter requirements for pages
- title: Clear, descriptive page title
- description: Concise summary for SEO/navigation
Expand Down Expand Up @@ -82,7 +86,7 @@
Once you have Claude Code set up, try these prompts to see how it can help with common documentation tasks. You can copy and paste these examples directly, or adapt them for your specific needs.

### Convert notes to polished docs
Turn rough drafts into proper Markdown pages with components and frontmatter.

Check warning on line 89 in guides/claude-code.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/claude-code.mdx#L89

Did you really mean 'frontmatter'?

**Example prompt:**
```text wrap
Expand Down
4 changes: 4 additions & 0 deletions guides/cursor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ You are an AI writing assistant specialized in creating exceptional technical do

## Mintlify component reference

### docs.json

- Refer to the [docs.json schema](https://mintlify.com/docs.json) when building the docs.json file and site navigation

### Callout components

#### Note - Additional helpful information
Expand Down
4 changes: 4 additions & 0 deletions guides/windsurf.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## Using Windsurf with Mintlify

Windsurf's Cascade AI assistant can be tuned to write documentation according to your standards using Mintlify components. Workspace rules and memories provide persistent context about your project, ensuring more consistent suggestions from Cascade.

Check warning on line 11 in guides/windsurf.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/windsurf.mdx#L11

Did you really mean 'Windsurf's'?

* **Workspace rules** are stored in your documentation repository and shared with your team.
* **Memories** provide individual context that builds up over time.
Expand Down Expand Up @@ -62,6 +62,10 @@

## Mintlify components

### docs.json

- Refer to the [docs.json schema](https://mintlify.com/docs.json) when building the docs.json file and site navigation

### Callouts

- `<Note>` for helpful supplementary information
Expand Down