An automated doc-syncing skill that monitors code changes, writes structured MDX documentation, validates links, and commits changes to Jamdesk repos.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install update-jamdesk
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install update-jamdesk using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is Update Jamdesk Documentation?
The update-jamdesk skill is designed to automate the process of keeping customer-facing documentation in sync with codebase changes. Built for developers using Openclaw Skills, this skill seamlessly bridges the gap between feature implementation and clear, accurate technical writing. It walks the developer and the AI agent through a highly organized workflow: locating configuration files, planning document structure, writing standard MDX content, and executing localized validation.
By leveraging the native jamdesk CLI, the skill checks for configuration schemas and broken links before any changes are committed. Whether your documentation lives in the same repository or an external Git workspace, this skill guarantees that no user-facing API changes, UI enhancements, or CLI commands go undocumented, maintaining high-quality docs without the manual overhead.
Update Jamdesk Documentation Use Cases
- When implementing new public-facing APIs, CLI commands, configuration options, or UI components that require immediate documentation update.
- When proactively maintaining technical accuracy after feature updates, ensuring outdated documentation is automatically flagged and resolved.
- When performing major code deprecations and migrating usage instructions or adding warnings for destructive operations.
- When updating docs.json navigation schemas and maintaining structured, multi-page technical guides.
How Update Jamdesk Documentation Works
- Locate Configuration: Searches up to the Git root for a
.jamdesk-docs-pathYAML file to identify the documentation folder and preferred Git branch. - Preflight Checks: Checks if the target path contains
docs.json, verifies the installation of thejamdeskCLI, and confirms the Git working tree is clean. - Clarify Scope: Confirms the branching strategy (for external documentation repos) and presents a proposed list of new or modified pages to the user.
- Analyze & Map Docs: Scans the target directory for existing references, identifying if a change requires a brand-new MDX file, an added section, or interactive components like accordions.
- Write Standardized MDX: Generates clean, active-voice Markdown/MDX content with frontmatter descriptions, target-audience context, concrete examples, and verified navigation structures.
- Validate & Verify: Executes the CLI tools to check schema validity and uncover broken links, reverting safely if validation issues are detected.
- Commit & Push: Prompts the user to commit changes under
docs: [action]format, with optional PR generation for external repos.
Update Jamdesk Documentation Setup
Configure the skill in your project by placing a .jamdesk-docs-path YAML configuration file at your repository's Git root:
docs_path: ../customer-docs # Relative or absolute path to your docs folder
docs_branch: main # Base branch for documentation updates
Ensure that your target documentation directory includes a valid docs.json file. If you are using Openclaw Skills to validate documentation locally, make sure the jamdesk CLI is globally accessible:
npm install -g @jamdesk/cli
If the CLI is not detected, the skill will gracefully fall back to a manual checklist to verify your frontmatter structure, images, and relative links before completion.
Update Jamdesk Documentation Data Schema & Taxonomy
The skill relies on specific YAML configuration files and standardizes MDX structures as follows:
| File / Location | Format | Description |
|---|---|---|
.jamdesk-docs-path |
YAML | Located at the code repo Git root; stores relative path to the docs repository and the base target branch. |
docs.json |
JSON | Located in the target docs folder; defines navigation structures and doc hierarchies. |
| Page Frontmatter | YAML-like | Located at the top of MDX files; requires title (<= 60 chars) and a unique, SEO-friendly description (120-160 chars). |
| Image Assets | Binary / Absolute Paths | Stored in /images/<feature>/ directory inside the docs repository. |
Minimal MDX Document Layout
---
title: Feature Name
description: SEO description (120-160 chars, unique per page)
lastUpdated: YYYY-MM-DD
---
Opening introduction context.
## Prerequisites
- Node.js 18+
## Quick Start
```bash
# Run command
Update Jamdesk Documentation Advanced Features
- External & Multi-Repo Orchestration: Automatically handles separate branch strategies, diff presentations, and commit flows when your documentation lives in a completely different Git repository.
- Intelligent Dry-Run Preview: Run with
--previewflag to analyze changes, generate documentation mappings, and review prospective creations without modifying active files. - Built-in Component Richness: Integrates structured UI components such as
<Tabs>,<Steps>,<Accordion>, and<CodeGroup>directly into your generated MDX files. - Self-healing Reverts: Restricts checkout reverts strictly to the workspace files written by this specific skill run, protecting pre-existing uncommitted user changes from accidental deletion.
SKILL.md
Loading
Related Openclaw Skills
Add Chinese Guides to Paper Sections
An AI agent skill that transforms academic paper inputs into structured, section-by-section Chinese guided-reading editions to help readers navigate complex research.
AEVRIS Security Skill
A deterministic AI security middleware designed to block prompt injections, verify outputs, scan MCP tool definitions, and safeguard agent execution.
Gang Leader for a Day Ethnography & Urban Sociology Skill
An interactive ethnographic research tool based on Sudhir Venkatesh's Gang Leader for a Day to analyze street economics, tenant leadership, and systemic urban poverty.
Creativity, Inc. AI Skill
An executable AI-agent skill that applies Ed Catmull's Pixar-proven frameworks to build fearless, candid, and highly collaborative creative cultures.
Data Format Encoder
An essential data transformation tool that allows AI agents to encode, decode, escape, and convert text between Base64, URL percent-encoding, HTML entities, JSON, Hexadecimal, Binary, ROT13, and Unicode formats.
Jarvis Core
A foundational personality, memory, and cognitive architecture that transforms AI agents from transactional tools into highly empathetic, self-improving companions.
Featured*
