---
title: Automated Doc Updates
description: Keep documentation in sync with your code using the /update-jamdesk skill for Claude Code. Automatically update docs when you implement features.
---

The `/update-jamdesk` skill for Claude Code watches your code changes and generates matching documentation updates. After you ship a user-facing feature, run the skill and it will figure out which doc pages need creating or editing.

<Note>
**Looking for general AI writing tips?** This page covers the `/update-jamdesk` skill for automated documentation updates. For tool setup, see [Claude Code](/ai/claude-code). For broader guidance on using AI tools to write docs, see [Writing with AI](/ai/writing-with-ai).
</Note>

## When to Use

**Use when:** You've made user-facing changes to APIs, CLI commands, UI, config options, or component behavior.

**Skip when:** Internal refactors, test-only changes, build/CI config, or performance work without behavior change—these don't need user-facing docs.

## Prerequisites

- [Claude Code](https://claude.ai/code) installed and configured
- A Jamdesk documentation project with `docs.json`
- Optional: [Jamdesk CLI](/cli/overview) for verification (`npm install -g jamdesk`)

## Quick Start

<Steps>
  <Step title="Create Config File">
    Create a `.jamdesk-docs-path` file in your code repository pointing to your docs:

    ```yaml .jamdesk-docs-path
    docs_path: ../my-docs
    ```

    The path can be relative (from the config file) or absolute.
  </Step>
  <Step title="Run the Skill">
    After implementing a feature, run:

    ```text
    /update-jamdesk
    ```

    Claude will analyze your changes and ask clarifying questions before writing documentation.
  </Step>
  <Step title="Review and Commit">
    Review the generated documentation, then Claude will verify it with `jamdesk validate` and `jamdesk broken-links` before committing.
  </Step>
</Steps>

## Config File Format

The `.jamdesk-docs-path` file tells Claude where your documentation lives.

**Simple format** - just the path:

```text
../my-docs
```

**Full format** - with options:

```yaml .jamdesk-docs-path
# Path to documentation repository
docs_path: ../my-docs

# Optional: Branch for doc updates (default: main)
docs_branch: main
```

<Note>
  The config file is discovered by walking up from your current directory to the git root. Place it in your repository root for best results.
</Note>

## How It Works

When you run `/update-jamdesk`, Claude:

1. **Locates your docs** - Finds the `.jamdesk-docs-path` config file
2. **Asks questions** - Clarifies branch strategy, scope, and content
3. **Analyzes existing docs** - Searches for related content to update or extend
4. **Writes documentation** - Creates or updates pages following Jamdesk standards, with simple examples first
5. **Reviews tone** - Check the output for AI filler. Claude writes better with a CLAUDE.md that sets the voice (see [Claude Code](/ai/claude-code))
6. **Verifies** - Runs `jamdesk validate` and `jamdesk broken-links`
7. **Commits** - Stages changes and offers to commit/push/PR

<Tip>
  Don't like the changes? Run `git checkout .` before committing to revert all edits.
</Tip>

<Accordion title="How Claude decides what to create vs update">
  | Scenario | Action |
  |----------|--------|
  | New feature | Create new page |
  | Behavior change | Update existing page |
  | Small addition | Add section to existing page |
  | Major capability | New standalone page |
  | Deprecation/removal | Update existing + add migration notes |
</Accordion>

## Example Session

```text
User: I just added a webhook feature. Can you document it?

Claude: I'm using the update-jamdesk skill to update your documentation.

Found .jamdesk-docs-path: ../customer-docs

How should I handle changes to the docs repository?
1. Create a new feature branch (recommended)
2. Update directly on main
3. Use current branch

User: 1

Claude: Based on the webhook implementation, I plan to:
- Create: webhooks/overview.mdx
- Update: getting-started.mdx (add link)

Any changes to this plan?

User: Looks good

Claude: [Creates documentation...]

✓ jamdesk validate passed
✓ jamdesk broken-links passed

Commit these changes?
```

## Preview Mode

Run with `--preview` to see what would change without making edits:

```text
/update-jamdesk --preview
```

Preview mode lets you:
- Check what documentation needs updating
- Review proposed changes before committing
- See the skill's analysis without side effects

## Proactive Suggestions

After committing user-facing code changes, Claude may suggest:

```text
Tip: These changes affect user-facing features.
Run /update-jamdesk to update your documentation.
```

This appears when:
- You have a `.jamdesk-docs-path` config file, AND
- Your commit includes files matching user-facing patterns (API, CLI, components)

## Installing the Skill

Install the `/update-jamdesk` skill using the skills CLI:

```bash
npx skills add jamdesk/skills --skill update-jamdesk
```

This installs the skill to `.claude/skills/update-jamdesk/` in your project.

<Tabs>
  <Tab title="Project Install (Default)">
    Installs to your current project directory:

    ```bash
    npx skills add jamdesk/skills --skill update-jamdesk
    ```

    The skill is available when working in this project.
  </Tab>
  <Tab title="Global Install">
    Installs to your home directory for use across all projects:

    ```bash
    npx skills add jamdesk/skills --skill update-jamdesk -g
    ```

    The skill is available in any project.
  </Tab>
  <Tab title="Other Agents">
    Install to Cursor, Codex, Windsurf, or other supported agents:

    ```bash
    # Install to Cursor
    npx skills add jamdesk/skills --skill update-jamdesk -a cursor

    # Install to multiple agents
    npx skills add jamdesk/skills --skill update-jamdesk -a claude-code -a cursor
    ```

    Run `npx skills add --help` to see all supported agents.
  </Tab>
</Tabs>

### Listing Available Skills

See all Jamdesk skills:

```bash
npx skills add jamdesk/skills --list
```

### Updating

Re-run the install command to get the latest version:

```bash
npx skills add jamdesk/skills --skill update-jamdesk
```

<Note>
  After installing or updating, restart Claude Code or start a new session for changes to take effect.
</Note>

## Troubleshooting

<Accordion title="Skill not recognized">
  Make sure the skill file is at `.claude/skills/update-jamdesk/SKILL.md` and restart your Claude Code session.
</Accordion>

<Accordion title="Config file not found">
  Create `.jamdesk-docs-path` in your repository root with the path to your docs directory. The skill searches from your current directory up to the git root.
</Accordion>

<Accordion title="jamdesk CLI not installed">
  Install with `npm install -g jamdesk`. The skill will work without it but won't run automated validation.
</Accordion>

## What's Next?

<Columns cols={2}>
  <Card title="MCP Server" icon="robot" href="/ai/mcp-server">
    Connect AI assistants directly to your docs
  </Card>
  <Card title="CLI Overview" icon="terminal" href="/cli/overview">
    Learn about the jamdesk CLI for local development
  </Card>
</Columns>