AI-Assisted Documentation
Use Claude Code to automatically update your Jamdesk docs when your code changes
Keep your documentation in sync with your code using the /update-jamdesk skill for Claude Code. When you implement user-facing features, this skill helps you create or update documentation automatically.
Prerequisites
- Claude Code installed and configured
- A Jamdesk documentation project with
docs.json - Optional: Jamdesk CLI for verification (
npm install -g jamdesk)
Quick Start
Create a .jamdesk-docs-path file in your code repository pointing to your docs:
docs_path: ../my-docsThe path can be relative (from the config file) or absolute.
After implementing a feature, run:
/update-jamdesk
Claude will analyze your changes and ask clarifying questions before writing documentation.
Review the generated documentation, then Claude will verify it with jamdesk validate and jamdesk broken-links before committing.
Config File Format
The .jamdesk-docs-path file tells Claude where your documentation lives.
Simple format - just the path:
../my-docs
Full format - with options:
# Path to documentation repository
docs_path: ../my-docs
# Optional: Branch for doc updates (default: main)
docs_branch: mainThe config file is discovered by walking up from your current directory to the git root. Place it in your repository root for best results.
How It Works
When you run /update-jamdesk, Claude:
- Locates your docs - Finds the
.jamdesk-docs-pathconfig file - Asks questions - Clarifies branch strategy, scope, and content
- Analyzes existing docs - Searches for related content to update or extend
- Writes documentation - Creates or updates pages following Jamdesk standards
- Verifies - Runs
jamdesk validateandjamdesk broken-links - Commits - Stages changes and offers to commit/push/PR
Example Session
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
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:
/update-jamdesk --preview
This is useful for:
- Checking what documentation needs updating
- Reviewing proposed changes before committing
- Understanding the skill's analysis without side effects
Proactive Suggestions
After committing user-facing code changes, Claude may suggest:
Tip: These changes affect user-facing features.
Run /update-jamdesk to update your documentation.
This appears when:
- You have a
.jamdesk-docs-pathconfig file, AND - Your commit includes files matching user-facing patterns (API, CLI, components)
Installing the Skill
The /update-jamdesk skill is available in two ways:
Download the skill to your project's .claude/skills/ directory:
Copy the skill file from the Jamdesk docs repository to your project:
mkdir -p .claude/skills/update-jamdesk
# Copy from your local jamdesk-docs clone, or download from the docs site
cp path/to/jamdesk-docs/skills/update-jamdesk/SKILL.md .claude/skills/update-jamdesk/This makes the skill available to anyone working on your project. Commit it to your repository.
After installing, restart Claude Code or start a new session for the skill to be recognized.
Troubleshooting
Make sure the skill file is at .claude/skills/update-jamdesk/SKILL.md and restart your Claude Code session.
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.
Install with npm install -g jamdesk. The skill will work without it but won't run automated validation.