Heading Hierarchy
thedaviddias/Front-End-Checklist
A skill your agent uses when reviewing rendered HTML, interactive components, or design-system patterns related to Use logical heading hierarchy.
Validates documentation structural integrity including heading hierarchy, metadata, file naming, navigation, and cross-references.
GPL-3.0Auto-check passed
Install Documentation Structure
$ npx skills add canonical/workshop --skill documentation-structure -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install canonical/workshop documentation-structure --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/canonical/workshop.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.github/skills/documentation-structure .claude/skills/documentation-structure && rm -rf skills-srcUse ~/.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/
Install the "documentation-structure" agent skill from https://github.com/canonical/workshop/tree/main/.github/skills/documentation-structure into .claude/skills/documentation-structure/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-structure", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/canonical/workshop/tree/main/.github/skills/documentation-structureType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add canonical/workshop --skill documentation-structure -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install canonical/workshop documentation-structure --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/canonical/workshop.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.github/skills/documentation-structure .agents/skills/documentation-structure && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "documentation-structure" agent skill from https://github.com/canonical/workshop/tree/main/.github/skills/documentation-structure into .agents/skills/documentation-structure/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-structure", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add canonical/workshop --skill documentation-structure -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install canonical/workshop documentation-structure --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/canonical/workshop.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.github/skills/documentation-structure .cursor/skills/documentation-structure && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "documentation-structure" agent skill from https://github.com/canonical/workshop/tree/main/.github/skills/documentation-structure into .cursor/skills/documentation-structure/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-structure", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/canonical/workshop.git --path .github/skills/documentation-structure--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add canonical/workshop --skill documentation-structure -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install canonical/workshop documentation-structure --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/canonical/workshop.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.github/skills/documentation-structure .gemini/skills/documentation-structure && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "documentation-structure" agent skill from https://github.com/canonical/workshop/tree/main/.github/skills/documentation-structure into .gemini/skills/documentation-structure/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-structure", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install canonical/workshop documentation-structureInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add canonical/workshop --skill documentation-structure -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/canonical/workshop.git skills-src && mkdir -p .github/skills && cp -r skills-src/.github/skills/documentation-structure .github/skills/documentation-structure && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "documentation-structure" agent skill from https://github.com/canonical/workshop/tree/main/.github/skills/documentation-structure into .github/skills/documentation-structure/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-structure", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add canonical/workshop --skill documentation-structure -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install canonical/workshop documentation-structure --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/canonical/workshop.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.github/skills/documentation-structure .opencode/skills/documentation-structure && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "documentation-structure" agent skill from https://github.com/canonical/workshop/tree/main/.github/skills/documentation-structure into .opencode/skills/documentation-structure/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-structure", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
documentation-structure- GitHub stars
- 114
- Token cost
- ~704 tokens
- SKILL.md length
- 308 words
- Files
- 1
- Skills in repo
- 6
- Repo updated
- First seen
- Licence
- GPL-3.0
At a glance
Validates documentation structural integrity including heading hierarchy, metadata, file naming, navigation, and cross-references.
- Works in 6 steps: File Naming → Metadata → Directory Placement → …
- Checking documentation organization
- SKILL.md covers Scope, Inputs, Actions and Constraints, plus 1 more section
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Documentation Structure is an agent skill from canonical/workshop. Validates documentation structural integrity including heading hierarchy, metadata, file naming, navigation, and cross-references. Use when checking documentation organization or validating toctree structure.
Its SKILL.md is about 700 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 documentation organization
- Validating toctree structure
Example prompts
- “Use the documentation-structure skill to validate documentation structural integrity including heading hierarchy, metadata, file naming, navigation…”
- “/documentation-structure”
Workflow steps
6 steps, taken from the first numbered list in SKILL.md.
- File Naming
- Metadata
- Directory Placement
- Navigation
- Cross-References
- Verification
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
No scripts in the folder and no shell commands in SKILL.md.
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 Structure loads about 704 tokens when it runs. Until then it costs about 58 tokens; SKILL.md has 308 words of instructions outside code blocks.
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). 308 words, ~704 tokens.
Download SKILL.mdSave it as
.claude/skills/documentation-structure/SKILL.md (or your agent's skills folder).- name
- documentation-structure
- description
- Validates documentation structural integrity including heading hierarchy, metadata, file naming, navigation, and cross-references. Use when checking documentation organization or validating toctree structure.
Documentation Structure Audit
Scope
Document structure only: heading hierarchy, section ordering, presence of required sections (introduction, prerequisites, steps, reference), file naming, metadata blocks, navigation, and cross-references.
Inputs
- Documentation file(s) under review.
- Documentation directory structure.
- Diataxis classification output
(from the
documentation-diataxisskill, when run as part of the orchestrated review).
Actions
File Naming:
Verify files use lowercase with dashes and the correct extension for their syntax (for example,
connect-vscode.rstfor reST,connect-vscode.mdfor MyST).Metadata:
Ensure every page has required metadata near the top when the repository's docs conventions require it:
.. meta::after the anchor label for reST, or the MyST equivalent (front matter ormetadirective) for Markdown sources.Directory Placement:
Confirm the file is located in the directory matching its intended Diataxis category (for example, tutorials in
tutorial/, how-to guides inhow-to/).Navigation:
Ensure new pages are added to the
toctree.Cross-References:
- Prefer stable reference roles
(
:ref:for reST,{ref}/{numref}for MyST) over page-level links. - Flag uses of
:doc:/{doc}(or equivalents) except for index-like pages that are unlikely to be moved or renamed. - Suggest adding links to improve documentation discoverability.
- Verify cross-references resolve correctly.
- Prefer stable reference roles
(
Verification:
Confirm the structural audit completed:
- File naming checked for all files
- Metadata presence verified
- Directory placement validated (using Diataxis classification if available)
- Navigation structure checked (toctree entries)
- Cross-references validated
State the completion status:
✓ Structure audit complete: [N] violations found- OR
✓ Structure audit complete: No violations found
Constraints
- Do not modify files during the audit; this is a read-only review.
- Do not invent metadata requirements; check against repository's documented conventions.
- Focus on structural issues only; do not flag style preferences.
- When Diataxis classification is available (from orchestrated review), use it to validate directory placement. Otherwise, infer from directory name.
Output
A list of structural or metadata violations covering file naming, metadata, directory placement, navigation, and cross-reference issues.
© 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-structure of canonical/workshop.
Open the folder on GitHubat commit 0b41ee9
Compare with similar skills
Documentation Structure 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.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Documentation Structure this skillcanonical/workshop | 114 | — | ~704 | Automated safety check: Pass | GPL-3.0 | |
| Heading Hierarchythedaviddias/Front-End-Checklist | 74k | — | ~516 | Automated safety check: Pass | MIT | |
| Validate Integrationsimstudioai/sim | 30k | — | ~8.7k | Automated safety check: Pass | Apache-2.0 | |
| Validating Backup Integrity For Recoverymukul975/Anthropic-Cybersecurity-Skills | 34k | — | ~1.9k | Automated safety check: Pass | Apache-2.0 | |
| Heading Structurekostja94/marketing-skills | 1k | — | ~903 | Automated safety check: Pass | MIT | |
| Bio Structural Biology Structure ValidationGPTomics/bioSkills | 1.2k | 1 repos | ~5.9k | Automated safety check: Pass | MIT |
Similar skills
Validate Integration
simstudioai/sim
Validate an existing Sim integration (tools, block, registry, and resolved-secret/model-input boundaries) against the service's API docs and Sim execution conventions
Validating Backup Integrity For Recovery
mukul975/Anthropic-Cybersecurity-Skills
Validates backup integrity through cryptographic hash verification, automated restore testing, corruption detection, and recoverability checks to confirm backups are reliable for disaster recovery…
Heading Structure
kostja94/marketing-skills
When the user wants to write or optimize H1-H6, fix heading hierarchy, improve content structure, rewrite an H1, or align headings with page intent.
Bio Structural Biology Structure Validation
GPTomics/bioSkills
Judges whether a macromolecular model (or a region of it) is reliable enough to build on, using resolution, R-free, B-factors, MolProbity geometry, and predicted-model confidence with Bio.PDB.
Validating Database Integrity
jeremylongshore/tons-of-skills-marketplace
Process use when you need to ensure database integrity through comprehensive data validation.
More from canonical/workshop
Documentation Build
canonical/workshop
Validates documentation builds successfully. An agent skill from canonical/workshop.
Documentation Review
canonical/workshop
Performs comprehensive documentation review including build validation, Diataxis analysis, structure audit, accuracy verification, and style compliance.
Documentation Style
canonical/workshop
Enforces project documentation style guide compliance for tone, voice, terminology, punctuation, and formatting.
Documentation Verify
canonical/workshop
Verifies documentation accuracy by cross-referencing claims, CLI commands, API signatures, and configuration against source code.
Documentation Diataxis
canonical/workshop
Analyzes documentation against Diataxis framework (Tutorial, How-to, Reference, Explanation).
Questions about Documentation Structure
What does Documentation Structure do?
Validates documentation structural integrity including heading hierarchy, metadata, file naming, navigation, and cross-references. Documentation Structure is an agent skill from canonical/workshop. Validates documentation structural integrity including heading hierarchy, metadata, file naming, navigation, and cross-references.
When should I use Documentation Structure?
Documentation Structure fits situations like: checking documentation organization; validating toctree structure.
How do I install Documentation Structure in Claude Code?
Run `npx skills add canonical/workshop --skill documentation-structure -a claude-code`. Or copy the skill folder (.github/skills/documentation-structure in canonical/workshop) into .claude/skills/documentation-structure in your project. Claude Code loads it when a task matches its description.
How do I install Documentation Structure in Codex?
Run `npx skills add canonical/workshop --skill documentation-structure -a codex`. Or copy the skill folder (.github/skills/documentation-structure in canonical/workshop) into .agents/skills/documentation-structure in your project. Codex loads it when a task matches its description.
Can I use Documentation Structure 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-structure -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-structure, .gemini/skills/documentation-structure, .github/skills/documentation-structure and .opencode/skills/documentation-structure in your project.
What does Documentation Structure need to run?
SKILL.md names no scripts, command-line tools or credentials: Documentation Structure is instructions for the agent only.
Does Documentation Structure 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 Structure 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 Structure use?
Documentation Structure 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 Structure use?
About 704 tokens (SKILL.md is roughly 2.8k 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 Structure?
Skills that share tags, products or a category with Documentation Structure: Heading Hierarchy (thedaviddias/Front-End-Checklist, 74k stars), Validate Integration (simstudioai/sim, 30k stars), Validating Backup Integrity For Recovery (mukul975/Anthropic-Cybersecurity-Skills, 34k stars) and Heading Structure (kostja94/marketing-skills, 1k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Documentation Structure?
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.