engram-code-docs

Enforces documentation standards for Rust and TypeScript codebases.

Updated Jun 29, 2026
One-click install
npx skills add https://github.com/phanijapps/engram --skill engram-code-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: engram-code-docs
Source: https://github.com/phanijapps/engram/tree/main/.claude/skills/engram-code-docs
Command: npx skills add https://github.com/phanijapps/engram --skill engram-code-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the challenge of maintaining consistent, high-quality documentation for complex Rust and TypeScript codebases, ensuring that public APIs, traits, and adapter boundaries remain clear and auditable.

Core Features & Use Cases

  • Documentation Standards Enforcement: Provides a structured review process for Rust module docs and TypeScript JSDoc.
  • Contract-First Documentation: Ensures code changes align with domain semantics defined in the Engram data model.
  • Use Case: When refactoring a core Rust trait or adding a new TypeScript SDK export, use this skill to verify that all public surfaces are documented according to project standards and that invariants are clearly stated.

Quick Start

Use the engram-code-docs skill to review the documentation for the newly added adapter module and ensure it meets the project standards.

Frequently Asked Questions about engram-code-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce documentation standards for Rust and TypeScript codebases?

You can enforce documentation standards for Rust and TypeScript codebases by validating module-level and public API documentation against domain-specific requirements using automated review processes and project-defined hooks.

How do I ensure TypeScript JSDoc and Rust module docs meet API design standards?

Ensuring TypeScript JSDoc and Rust module docs meet API design standards involves applying a structured review process that checks public surfaces, traits, and adapter boundaries for clear invariants and contract-first domain semantics.

Can I use automated code review to verify SDK documentation for public APIs?

Yes, you can use automated code review to verify SDK documentation for public APIs by validating that newly added exports and trait implementations adhere to predefined project documentation standards and domain-specific invariants.

What is the best way to standardize code documentation for Rust traits and TypeScript exports?

The best way to standardize code documentation for Rust traits and TypeScript exports is to enforce contract-first documentation requirements that align code changes with domain data models and validate them through project-defined hooks.

Does this documentation validation process work without external dependencies?

Yes, this documentation validation process works without external dependencies, relying entirely on internal reference components and project-defined hooks to enforce module-level and public API documentation standards.

When do I need to enforce contract-first documentation for adapter boundaries?

You need to enforce contract-first documentation for adapter boundaries when refactoring core Rust traits or adding new TypeScript SDK exports, ensuring all public surfaces remain clear, auditable, and aligned with domain semantics.