Engram Docs Alignment

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

Gentleman-Programming Updated 8.2k repo stars
Engram neon elephant banner: the elephant exhales a memory stream (remember, sync, recall), the ENGRAM wordmark is written on, and the tagline One Brain. Local

File contents

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

Gentleman-Programming/engram commit c1cd084d3f

Frequently asked questions

npx get-skill add gentleman-programming-engram/engram-docs-alignment