mcpField
W
w-docs

w-docs

github.com/blockmaticDevelopment1647 installsUpdated 4w ago
Repository

About w-docs

w-docs is a repository skill for updating documentation alongside code changes. It helps agents place explanations in the right existing documentation layer and avoid duplicating project information.

Key features

  1. 01Selects the matching documentation section
  2. 02Updates canonical MDX topic pages
  3. 03Limits README edits to setup and run details
  4. 04Updates agent rules only when constraints change
  5. 05Avoids unrequested file moves and commits

Use cases

  1. 01Documenting changed behavior or architecture
  2. 02Updating setup instructions after script changes
  3. 03Organizing proposed documentation file moves

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/blockmatic/basilic-skills --skill w-docs

After installing, type/w-docsin Claude Code to confirm it loaded.

Details

From the project README

Document the current code or feature. Follow the consuming repo's docs and README rules. Do not commit unless asked. Durable information architecture belongs in existing MDX; do not invent a second sitemap.

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
Agent 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 matching docs section, then an 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 rule only if a constraint changed.
  5. For mechanical file or doc moves: propose the smallest from/to list grouped by related files; drop folder-name prefixes inside groups. Save only if the user gave a path. Do not move files unless they also asked to implement.

Comments

Markdown supported