add-documentation

SkillDocs & knowledge

Add comprehensive documentation for current code/feature per project standards (README, technical docs site, or inline comments). Use when the user types /add-documentation.

Available today. Use it from your connected AI after setup.

Connect ahel once, and every AI you use reads what you have installed.

Then ask your AI: use the add-documentation skill

What this skill tells your AI

The instructions your AI receives, as published by blockmatic/basilic in .agents/skills/workflow/add-documentation/SKILL.md and read by ahel’s review.

Purpose and inputs

Document the current code or feature. Follow .cursor/rules/base/docs.mdc and .cursor/rules/base/readme.mdc. Do not commit unless asked.

Steps

Write to the layer that owns the change:

LayerRoleUpdate when
Technical docs (path in AGENTS.md)Architecture, ADRs, how-toBehavior, architecture, commands, conventions, or workflow changed
.cursor/rulesShort constraintsA convention the agent must not violate changed
Nearest READMEHow to run this app/package; links onlyScripts, setup, or package purpose changed

Inline comments only when the code is otherwise misleading. Do not copy MDX into rules or READMEs. Do not @-attach MDX.

  1. Identify the topic: Matching docs section, then existing topic page (create a page only if none fits)
  2. Write or patch MDX if the canonical explanation changed
  3. Patch README only for run/setup/scripts; link the MDX
  4. Patch the glob-matched .mdc only if a constraint changed

Verification

  • The owning docs layer matches the kind of change.
  • READMEs link to MDX instead of duplicating it.
  • No unsolicited commit.

Handoff

Report which files changed and which layers were intentionally left alone.

Signals

GitHub stars
89
Forks
11
Last commit
Sep 2026
Advanced
Catalog kind
skill
Gateway key
add-documentation
Source
github.com/blockmatic/basilic