连接

Engram Documentation Alignment

Gentleman-ProgrammingbyGentleman-Programming
•
1.9k
•
学习与文档

Synchronizes project documentation with code changes to ensure accuracy across APIs, CLI commands, and development workflows.

This skill enforces rigorous documentation standards for the Engram project, ensuring that user guides, API references, and contributor instructions always reflect the current state of the software. It automates the verification of endpoint names, command examples, and script paths during the development process, preventing the drift between code implementation and its description. It is particularly useful during API refactoring or CLI interface updates where stale documentation could mislead users or contributors.

主要功能

01Enforces documentation updates within the same PR as code changes
02Ensures cross-agent notes remain accurate for persistent memory systems
03Identifies and removes references to deprecated files and legacy scripts
04Synchronizes endpoint names with active server routes
05Validates CLI command examples for execution accuracy
061,850 GitHub stars

使用场景

01Modifying CLI tool arguments and command output formats
02Updating Engram REST API or MCP server endpoints
03Updating contributor onboarding guides and setup workflows