CtrlK
BlogDocsLog inGet started
Tessl Logo

engram-docs-alignment

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

69

Quality

83%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

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
Repository
Gentleman-Programming/engram
Last updated
First committed

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.