mcpField
E
engram-docs-alignment

engram-docs-alignment

github.com/gentleman-programmingDevelopment7.7k89 installsUpdated today
Repository

About engram-docs-alignment

engram-docs-alignment is a skill for keeping project documentation consistent with implemented behavior. It guides contributors through updating and validating docs alongside code changes.

Key features

  1. 01Document current behavior
  2. 02Update docs with code changes
  3. 03Validate examples before publishing
  4. 04Check routes, paths, and commands

Use cases

  1. 01Changing APIs or setup flows
  2. 02Updating CLI commands and examples
  3. 03Writing contributor guidance

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/gentleman-programming/engram --skill engram-docs-alignment

After installing, type/engram-docs-alignmentin Claude Code to confirm it loaded.

Details

From the project README

When to Use

Use this skill when:

  • Changing APIs, setup flows, or plugin behavior
  • Updating CLI commands or examples
  • Writing contributor guidance

Alignment Rules

  1. Docs must describe current behavior, not intended behavior.
  2. Update docs in the same PR as the code change.
  3. Validate examples before publishing.
  4. Remove references to deprecated files, endpoints, or scripts.

Verification

  • Endpoint names match server routes
  • Script names match repository paths
  • Command examples execute as documented
  • Cross-agent notes are still accurate

Comments

Markdown supported