engram-docs-alignment

star 4.4k

Documentation alignment rules for Engram. Trigger: Any code or workflow change that affects user or contributor behavior.

Gentleman-Programming By Gentleman-Programming schedule Updated 2/21/2026

name: engram-docs-alignment description: > Documentation alignment rules for Engram. Trigger: Any code or workflow change that affects user or contributor behavior. license: Apache-2.0 metadata: author: gentleman-programming version: "1.0"

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
Install via CLI
npx skills add https://github.com/Gentleman-Programming/engram --skill engram-docs-alignment
Repository Details
star Stars 4,398
call_split Forks 518
navigation Branch main
article Path SKILL.md
More from Creator
Gentleman-Programming
Gentleman-Programming Explore all skills →