Skip to content

feat: add doc-sync plugin for continuous documentation automation - #35

Closed
emma-praxis wants to merge 1 commit into
mainfrom
feat/doc-sync-plugin
Closed

feat: add doc-sync plugin for continuous documentation automation#35
emma-praxis wants to merge 1 commit into
mainfrom
feat/doc-sync-plugin

Conversation

@emma-praxis

Copy link
Copy Markdown
Collaborator

Overview

Implements a continuous documentation synchronization engine inspired by quickstop's Inkwell plugin, designed specifically for Claude Code workflows.

What It Does

Creates a bridge between agent-ready (initial scaffolding) and doc-audit (periodic validation) with automated, queue-based documentation updates triggered by code changes.

Key Features

  • Queue-based processing - Non-blocking documentation updates via git hooks
  • Agent-ready focus - Documentation formats optimized for AI agent consumption
  • Stack-aware presets - 5 preconfigured stacks (TypeScript, Rails, Python, Go, Rust)
  • Ecosystem integration - Works with existing agent-ready and doc-audit plugins
  • Agent schemas - Auto-documents agent capabilities and tool schemas

Implementation Details

  • 13 files, ~1,100 lines of implementation
  • PostToolUse + Stop hooks for automatic queue management
  • 5 skills for setup, processing, and maintenance
  • 2 specialized agents for doc writing and index building
  • Version 1.0.0 ready for marketplace

Files Added

Component Files Purpose
Core plugin.json, README.md Plugin identity and docs
Hooks hooks.json, 2 shell scripts Git integration
Agents doc-writer.md, index-builder.md Queue processing
Skills 5 skill directories Setup, capture, process, stale detection
Rules doc-hygiene.md Code conventions

Testing

Validated through comprehensive coding session with multiple review cycles and fixes applied.

Closes #[issue-number] (if applicable)

- Implements Inkwell-inspired queue-based documentation system
- Bridges agent-ready (scaffold) and doc-audit (validate) with continuous sync
- Adds PostToolUse and Stop hooks for automatic doc queue management
- Includes 5 stack presets (TypeScript, Rails, Python, Go, Rust)
- Features agent-schemas doc type for AI agent capability documentation
- Provides manual processing skills and staleness detection
- 13 files, ~1,100 lines of implementation
- Version 1.0.0 ready for marketplace
@dgalarza dgalarza closed this Apr 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants