New: 98,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Documentation Build

by canonical in canonical/workshop

Validates documentation builds successfully. An agent skill from canonical/workshop.

GPL-3.0Auto-check passed

Install Documentation Build

skills CLI
$ npx skills add canonical/workshop --skill documentation-build -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install canonical/workshop documentation-build --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/canonical/workshop.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.github/skills/documentation-build .claude/skills/documentation-build && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
documentation-build
GitHub stars
114
Token cost
~762 tokens
SKILL.md length
344 words
Files
1
Skills in repo
6
Repo updated
First seen
Licence
GPL-3.0

At a glance

Validates documentation builds successfully. An agent skill from canonical/workshop.

  • Works in 6 steps: Identify documentation directory: The… → Detect build configuration: Check for… → Run build targets (when applicable) → …
  • Checking Sphinx/RTD build integrity
  • SKILL.md covers Scope, Inputs, Actions and Constraints, plus 1 more section
  • Calls make

What it does

Documentation Build is an agent skill from canonical/workshop. Validates documentation builds successfully. Use when checking Sphinx/RTD build integrity or diagnosing build failures. Reports errors, warnings, and build configuration issues.

Its SKILL.md is about 760 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

The repository describes itself as: Workshops are secure, fast, and composable development environments that come agent-ready. The licence is GPL-3.0.

When your agent uses it

  • Checking Sphinx/RTD build integrity
  • Diagnosing build failures

Example prompts

  • “Use the documentation-build skill to validate documentation builds successfully. An agent skill from canonical/workshop”
  • “/documentation-build”

Workflow steps

6 steps, taken from the first numbered list in SKILL.md.

  1. Identify documentation directory: The docs/ directory
  2. Detect build configuration: Check for the presence of
  3. Run build targets (when applicable)
  4. Capture output and handle failures: If any command fails
  5. Categorise findings by severity
  6. Verify completion: Confirm the validation completed

What it can do on your machine

Read from SKILL.md and the folder at commit 0b41ee9. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • make

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Documentation Build loads about 762 tokens when it runs. Until then it costs about 49 tokens; SKILL.md has 344 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~49
When it runs · the whole SKILL.md, loaded when a task matches
~762

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from canonical/workshop at commit 0b41ee9, republished under its GPL-3.0 licence (© canonical). 344 words, ~762 tokens.

Download SKILL.mdSave it as .claude/skills/documentation-build/SKILL.md (or your agent's skills folder).
name
documentation-build
description
Validates documentation builds successfully. Use when checking Sphinx/RTD build integrity or diagnosing build failures. Reports errors, warnings, and build configuration issues.

Documentation Build Validation

Scope

Build validation only: detect documentation build configuration, run applicable build targets, collect all errors and warnings, and categorise by severity.

Inputs

  • Repository root.

Actions

  1. Identify documentation directory: The docs/ directory is the default location for Sphinx documentation. If not found, search common doc roots in this order: doc/, documentation/, site/, docs-src/. If still not found, perform a bounded search for conf.py (max depth 4) and use its parent as the docs root.

  2. Detect build configuration: Check for the presence of:

    • .readthedocs.yaml
    • docs/conf.py
    • Makefile targets in the docs/ directory

    If RTD artefacts are absent in the target repository, report "not applicable" in findings and exit cleanly.

  3. Run build targets (when applicable):

    bash
    cd docs
make clean
make html

    Run additional checks for targets that exist. Check each target before running to avoid false failures:

    bash
    # Check and run each target if available
for target in spelling linkcheck woke lint-md; do
  if make -n $target 2>/dev/null; then
    make $target
  fi
done

  4. Capture output and handle failures: If any command fails:

    1. Capture the full error output from stderr and stdout
    2. Run make clean to reset build state
    3. Retry the failed build command once
    4. If retry fails, STOP and report all captured errors
    5. Do not proceed to content analysis until build succeeds

    Warnings must be collected and reported, but are not blocking unless the repository explicitly treats warnings as errors.

  5. Categorise findings by severity:

    • Errors: Build failures, broken links, missing files.
    • Warnings: Deprecation notices, missing references, formatting issues.
    • Info: Suggestions, minor notices.

  6. Verify completion: Confirm the validation completed:

    • Build targets were executed (or determined not applicable)
    • Output was captured (errors and warnings)
    • Findings were categorized by severity

    State the completion status:

    • ✓ Build validation complete: [N] errors, [M] warnings found
    • OR ✓ Build validation complete: No issues found
    • OR ✓ Build validation: Not applicable - RTD artifacts not detected
Show full SKILL.md (61 more words)Show less

Constraints

  • Do not approve documentation that fails the Sphinx build.
  • Build docs locally to catch build warnings.
  • Do not invent Makefile targets; only use targets confirmed to exist in the target repository.

Output

A build validation report listing all errors and warnings, categorised by severity. If RTD artefacts are not detected, report "Not applicable -- RTD artefacts not detected in target repo".

© canonical, GPL-3.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .github/skills/documentation-build of canonical/workshop.

Open the folder on GitHubat commit 0b41ee9

Compare with similar skills

Documentation Build next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Documentation Build compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Documentation Build this skillcanonical/workshop114—~762Automated safety check: PassGPL-3.0
Form Validationthedaviddias/Front-End-Checklist74k—~633Automated safety check: PassMIT
Lint And Validatesickn33/agentic-awesome-skills47k1 repos~814Automated safety check: PassMIT
Check PRpaperclipai/paperclip99k—~3.6kAutomated safety check: PassMIT
Validateagenticnotetaking/arscontexta3.5k—~3kAutomated safety check: PassMIT
Checkdavepoon/buildwithclaude3.6k—~680Automated safety check: PassMIT

Similar skills

  • Form Validation

    thedaviddias/Front-End-Checklist

    A skill your agent uses when reviewing templates, rendered HTML, or shared components related to Validate forms accessibly.

    74k GitHub stars~633 tokensUpdated 2 days ago
    Frontend & DesignAuto-check passed

  • Lint And Validate

    sickn33/agentic-awesome-skills

    Run configured lint and type checks, distinguish failures from checks that did not run, and report concrete validation results.

    47k GitHub starsUsed in 1 repo~814 tokens
    DevelopmentAuto-check passed

  • Check PR

    paperclipai/paperclip

    Check a GitHub, GitLab, or Perforce PR/MR/CL for review comments, failing checks, and PR-body gaps.

    99k GitHub stars~3.6k tokensUpdated today
    DevelopmentAuto-check passed

  • Validate

    agenticnotetaking/arscontexta

    Schema validation for notes. An agent skill from agenticnotetaking/arscontexta.

    3.5k GitHub stars~3k tokensUpdated 7 mo ago
    Frontend & DesignAuto-check passed

  • Check

    davepoon/buildwithclaude

    Run CIAgent regression checks after changing an AI agent's code, prompts, or knowledge base in a repo that has agentcispec.yaml, and interpret the results.

    3.6k GitHub stars~680 tokensUpdated 2 days ago
    Knowledge ManagementAuto-check passed

  • Zod Validation Expert

    davila7/claude-code-templates

    Expert in Zod — TypeScript-first schema validation. An agent skill from davila7/claude-code-templates.

    32k GitHub starsUsed in 3 repos~2.4k tokens
    Frontend & DesignAuto-check passed

More from canonical/workshop

  • Documentation Review

    canonical/workshop

    Performs comprehensive documentation review including build validation, Diataxis analysis, structure audit, accuracy verification, and style compliance.

    114 GitHub stars~1.9k tokensUpdated today
    Auto-check passed

  • Documentation Style

    canonical/workshop

    Enforces project documentation style guide compliance for tone, voice, terminology, punctuation, and formatting.

    114 GitHub stars~714 tokensUpdated today
    Auto-check passed

  • Documentation Verify

    canonical/workshop

    Verifies documentation accuracy by cross-referencing claims, CLI commands, API signatures, and configuration against source code.

    114 GitHub stars~932 tokensUpdated today
    Auto-check passed

  • Documentation Diataxis

    canonical/workshop

    Analyzes documentation against Diataxis framework (Tutorial, How-to, Reference, Explanation).

    114 GitHub stars~1.6k tokensUpdated today
    Auto-check passed

  • Documentation Structure

    canonical/workshop

    Validates documentation structural integrity including heading hierarchy, metadata, file naming, navigation, and cross-references.

    114 GitHub stars~704 tokensUpdated today
    Auto-check passed

Questions about Documentation Build

What does Documentation Build do?

Validates documentation builds successfully. An agent skill from canonical/workshop. Documentation Build is an agent skill from canonical/workshop. Validates documentation builds successfully.

When should I use Documentation Build?

Documentation Build fits situations like: checking Sphinx/RTD build integrity; diagnosing build failures.

How do I install Documentation Build in Claude Code?

Run `npx skills add canonical/workshop --skill documentation-build -a claude-code`. Or copy the skill folder (.github/skills/documentation-build in canonical/workshop) into .claude/skills/documentation-build in your project. Claude Code loads it when a task matches its description.

How do I install Documentation Build in Codex?

Run `npx skills add canonical/workshop --skill documentation-build -a codex`. Or copy the skill folder (.github/skills/documentation-build in canonical/workshop) into .agents/skills/documentation-build in your project. Codex loads it when a task matches its description.

Can I use Documentation Build in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add canonical/workshop --skill documentation-build -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/documentation-build, .gemini/skills/documentation-build, .github/skills/documentation-build and .opencode/skills/documentation-build in your project.

What does Documentation Build need to run?

Going by SKILL.md and its folder, Documentation Build needs the command-line tools its instructions call (make).

Does Documentation Build access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Documentation Build safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Documentation Build use?

Documentation Build is published under the GPL-3.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Documentation Build use?

About 762 tokens (SKILL.md is roughly 3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Documentation Build?

Skills that share tags, products or a category with Documentation Build: Form Validation (thedaviddias/Front-End-Checklist, 74k stars), Lint And Validate (sickn33/agentic-awesome-skills, 47k stars), Check PR (paperclipai/paperclip, 99k stars) and Validate (agenticnotetaking/arscontexta, 3.5k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Documentation Build?

canonical (a GitHub organization) maintains it in canonical/workshop, which has 114 GitHub stars. The repository holds 6 skills in this directory. The repository was last updated on October 8, 2026.

Source: canonical/workshop on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.