ai-context-writer

What problem does it solve?

Creating and maintaining ai-context.md files for modules helps teams surface module context to AI assistants and discovery tools. This skill standardizes module documentation so internal and external references are easily discoverable via /modules commands.

Core Features & Use Cases

• Automated ai-context.md generation: Produce standardized frontmatter (path, summary, tags) and a descriptive markdown body for modules found in packages/ or apps/ directories.
• Module discovery and indexing: Ensure modules (internal packages/apps and external references) are indexed for quick lookup by the context crawler.
• Documentation updates on refactor: Regenerate context files after significant changes to module interfaces or architecture.
• Use Case: Add a new internal package and generate ai-context.md to appear in /modules; extend an external reference by documenting its submodule in ai-context.md.

Quick Start

Use the ai-context-writer to create documentation for a module, for example: ai-context-writer --path packages/my-package --summary "One-line summary of the module" --tags effect,ai,docs

Note: Ensure the generated file is named exactly ai-context.md at the module root.