Jamdesk Documentation logo

Cursor

Configure o Cursor IDE para escrever documentação Jamdesk com regras de formatação MDX, autocompletar de componentes e acesso ao servidor MCP.

Cursor é um editor de código com IA baseado no VS Code. Sua edição inline (Cmd+K) e o chat (Cmd+L) funcionam bem para escrever MDX de forma iterativa: selecione um parágrafo, descreva o que deseja e o Cursor o reescreve no lugar.

Configuração rápida

1
Abra o projeto de documentação

Abra o diretório da sua documentação Jamdesk no Cursor.

2
Adicione as regras do Cursor

Crie .cursor/rules/jamdesk-docs.mdc com seus padrões de documentação. A IA do Cursor segue as convenções definidas nele.

3
Conecte o servidor MCP

Adicione o endpoint MCP da sua documentação em .cursor/mcp.json. Assim, o Cursor poderá pesquisar sua documentação publicada.

Modelo de regras do Cursor

Crie .cursor/rules/jamdesk-docs.mdc na raiz do seu projeto:

.cursor/rules/jamdesk-docs.mdc
---
description: Rules for writing Jamdesk documentation in MDX
globs: "**/*.mdx"
---

# Jamdesk MDX Rules

## Page Structure

Every page follows this pattern — no exceptions:

1. Frontmatter with `title` and `description`
2. Opening paragraph (no heading before it)
3. Content sections with ## headings
4. "What's Next?" section at the end with Card links inside Columns

## Components

Only use these — do not invent others:

Layout: Card, Columns, Tabs, Tab, Accordion, AccordionGroup, Steps, Step, Expandable, Frame, CodeGroup
Callouts: Note, Info, Warning, Tip, Check, Danger

| Use | For |
|-----|-----|
| Tabs | Mutually exclusive choices (npm/yarn, OS variants) |
| Steps | Ordered procedures the reader follows |
| Accordion | Optional detail that would clutter the page |
| Card + Columns | Navigation links and feature grids |
| Note/Tip/Warning | Important context — use sparingly |

Cards always go inside Columns: `<Columns cols={2}><Card ... /></Columns>`
Icons are Font Awesome Light names: "rocket", "code", "terminal", "book-open"

## Style

- Active voice: "Run this command" not "This command should be run"
- Start with why, then how
- One idea per paragraph
- Code examples must be complete and copy-pasteable
- Write like a person — no filler ("It's important to note"), no hedging ("you might want to consider"). If it sounds like a chatbot, rewrite it shorter.

## Common Mistakes

- `<CodeBlock>`, `<Alert>`, `<Section>` don't exist — use the components listed above
- `<Card>` without `<Columns>` wrapper won't render correctly
- Missing `description` in frontmatter breaks search and link previews
- Raw HTML tags should be MDX components instead

## New Pages

When creating a page, add it to `docs.json` navigation. Without this, the page won't appear in the sidebar. Read `docs.json` first to understand the group structure.

Configuração do MCP

Crie .cursor/mcp.json para conectar sua documentação publicada:

.cursor/mcp.json
{
  "mcpServers": {
    "my-docs": {
      "url": "https://your-project.jamdesk.app/_mcp"
    }
  }
}

Substitua your-project pelo seu subdomínio Jamdesk. Se você tiver um domínio personalizado ativo, use-o no lugar: "url": "https://docs.acme.com/_mcp". Veja Servidor MCP para os detalhes dos endpoints.

Fluxos de trabalho

Selecione um texto em um arquivo MDX e pressione Cmd+K para descrever a alteração desejada. Funciona bem para:

  • Reescrever uma seção para ganhar clareza
  • Adicionar um exemplo de código
  • Converter texto em um componente (por exemplo, envolver passos em <Steps>)

A skill /update-jamdesk

Instale a skill /update-jamdesk para atualizar a documentação automaticamente quando o código mudar:

npx skills add jamdesk/skills --skill update-jamdesk -a cursor

Veja Atualizações automatizadas para o guia completo.

Próximos passos?

Claude Code

Modelo de CLAUDE.md e fluxos de trabalho com contexto de projeto completo

Escrever com IA

Prompts, checklists de revisão e armadilhas comuns