Jamdesk Skills

AI agent skills for Jamdesk documentation workflows. These skills help AI coding assistants automatically keep your documentation in sync with your code.

What is Jamdesk?

Jamdesk is a documentation platform that transforms MDX (Markdown + React components) into polished documentation websites. Write in Markdown, push to GitHub, and deploy globally in seconds.

Key features:

• MDX-based workflow with 25+ built-in components
• Three professional themes (Jam, Nebula, Pulsar)
• AI-powered search and LLM-ready output (llms.txt)
• Built-in analytics and OpenAPI support
• Custom domains with SSL

New to Jamdesk? Check out the documentation to get started, or try the quickstart guide to deploy your first docs site in minutes.

Why Use These Skills?

Documentation often falls out of sync with code. These skills solve that by teaching AI coding assistants how to automatically update your Jamdesk docs when you make changes to APIs, CLI commands, UI components, or configuration options.

The workflow:

1. You implement a feature in your codebase
2. Run /update-jamdesk in your AI assistant
3. The skill analyzes your changes and creates or updates documentation
4. Review, verify, and commit

No more outdated docs. No more "I'll document it later."

Quick Start

# 1. Install the skill
npx skills add jamdesk/skills --skill update-jamdesk

# 2. Create a config file pointing to your docs
echo "docs_path: ../my-docs" > .jamdesk-docs-path

# 3. After implementing a feature, run in your AI assistant:
/update-jamdesk

The skill will analyze your changes, ask clarifying questions, write documentation, and offer to commit.

Installation

Install skills using the skills CLI:

# Install a specific skill
npx skills add jamdesk/skills --skill update-jamdesk

# Install globally (available in all projects)
npx skills add jamdesk/skills --skill update-jamdesk -g

# Install all Jamdesk skills
npx skills add jamdesk/skills

Available Skills

Skill	Description
update-jamdesk	Automatically updates Jamdesk documentation when code changes

Supported AI Coding Assistants

These skills work with any AI coding assistant that supports the skills format:

• Claude Code - Anthropic's CLI for Claude
• Cursor - AI-first code editor
• Windsurf - Codeium's AI IDE
• Codex - OpenAI's coding assistant
• OpenCode - Open-source AI coding tool
• And 30+ more agents

Run npx skills add --help for the full list of supported agents.

How It Works

The update-jamdesk skill teaches your AI assistant to:

1. Find your docs - Locates your Jamdesk project via a .jamdesk-docs-path config file
2. Understand changes - Analyzes what you've built and asks clarifying questions
3. Write documentation - Creates or updates MDX pages following Jamdesk conventions
4. Verify - Runs jamdesk validate and checks for broken links
5. Commit - Stages changes and offers to commit/push/create a PR

Requirements

• A Jamdesk documentation project with docs.json
• An AI coding assistant (Claude Code, Cursor, etc.)
• A .jamdesk-docs-path config file in your code repository
• Optional: Jamdesk CLI for local validation

Config File

Create a .jamdesk-docs-path file in your code repository root:

# Path to your Jamdesk docs (relative or absolute)
docs_path: ../my-docs

# Optional: default branch for doc updates
docs_branch: main

Documentation

• Jamdesk Documentation - Full platform docs
• Automated Doc Updates Guide - Detailed skill usage
• MDX Basics - Writing content in Jamdesk
• Components Reference - Available MDX components

Contributing

To add a new skill:

1. Create a directory: skills/<skill-name>/
2. Add a SKILL.md file with YAML frontmatter (name, description)
3. Write instructions in Markdown
4. Submit a pull request

See CLAUDE.md for detailed guidelines.

License

MIT