Can it validate code examples?

Yes, one of its core verification steps is ensuring that all command examples provided in the documentation execute exactly as described in the repository.

Does it support external documentation sites?

It focuses on the documentation within the repository, ensuring files, endpoints, and script names align with the current state of the Engram codebase.

When does this skill trigger during development?

It triggers whenever there is a change to APIs, CLI commands, setup flows, or any workflow that impacts user or contributor behavior.

How does it handle deprecated features?

The skill includes specific rules to remove references to deprecated files, endpoints, or legacy scripts to maintain a clean and accurate source of truth.

What is the primary benefit of the Engram Docs Alignment skill?

It ensures that your technical documentation never falls behind your code by requiring updates in the same PR and validating all examples before they are published.

Engram Documentation Alignment

Name: Engram Documentation Alignment
Author: Gentleman-Programming

byGentleman-Programming

•

1,850

•

Learning & Documentation

Synchronizes technical documentation with code changes to ensure accuracy across APIs, CLI commands, and setup flows.

The Engram Documentation Alignment skill automates the synchronization of technical guides with codebase changes for the Engram memory system. It enforces a strict documentation-as-code workflow, ensuring that any modifications to APIs, CLI commands, or setup procedures are immediately reflected in the documentation within the same pull request. By validating code examples and purging deprecated references, this skill maintains high-quality, actionable documentation for both users and contributors, significantly reducing developer friction and preventing documentation rot.

Key Features

01Documentation synchronization within PR workflows

021,850 GitHub stars

03Real-time validation of CLI and API examples

04Automatic identification of deprecated references

05Consistency checks for cross-agent documentation

06Standardized contributor guidance enforcement

Use Cases

01Updating CLI usage examples after a feature release

02Refining contributor guides during setup flow changes

03Syncing API endpoint documentation with new server routes

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add gentleman-programming/engram docs-alignment

For use in Claude.ai and ChatGPT

Key Features

01Documentation synchronization within PR workflows

021,850 GitHub stars

03Real-time validation of CLI and API examples

04Automatic identification of deprecated references

05Consistency checks for cross-agent documentation

06Standardized contributor guidance enforcement

Use Cases

01Updating CLI usage examples after a feature release

02Refining contributor guides during setup flow changes

03Syncing API endpoint documentation with new server routes

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add gentleman-programming/engram docs-alignment

For use in Claude.ai and ChatGPT