{"id":48582524,"url":"https://github.com/zircote/documentation-review","last_synced_at":"2026-04-08T17:34:11.077Z","repository":{"id":333058648,"uuid":"1136076994","full_name":"zircote/documentation-review","owner":"zircote","description":"Claude Code plugin for comprehensive documentation management — review, create, update, and maintain high-quality technical documentation with intelligent AI-powered analysis.","archived":false,"fork":false,"pushed_at":"2026-03-01T15:20:59.000Z","size":1883,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-01T18:32:44.928Z","etag":null,"topics":["ai-tools","api-documentation","asyncapi","changelog","claude-code","claude-code-plugin","developer-tools","doc-generation","doc-review","docs-as-code","documentation","documentation-standards","docusaurus","markdown","mkdocs","openapi","quality-assurance","sphinx","swagger","technical-writing"],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zircote.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"zircote"}},"created_at":"2026-01-17T02:55:39.000Z","updated_at":"2026-03-01T15:21:02.000Z","dependencies_parsed_at":"2026-02-22T14:03:41.276Z","dependency_job_id":null,"html_url":"https://github.com/zircote/documentation-review","commit_stats":null,"previous_names":["zircote/documentation-review"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/zircote/documentation-review","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zircote%2Fdocumentation-review","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zircote%2Fdocumentation-review/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zircote%2Fdocumentation-review/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zircote%2Fdocumentation-review/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zircote","download_url":"https://codeload.github.com/zircote/documentation-review/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zircote%2Fdocumentation-review/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31567056,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"ssl_error","status_checked_at":"2026-04-08T14:31:17.202Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai-tools","api-documentation","asyncapi","changelog","claude-code","claude-code-plugin","developer-tools","doc-generation","doc-review","docs-as-code","documentation","documentation-standards","docusaurus","markdown","mkdocs","openapi","quality-assurance","sphinx","swagger","technical-writing"],"created_at":"2026-04-08T17:34:10.836Z","updated_at":"2026-04-08T17:34:10.962Z","avatar_url":"https://github.com/zircote.png","language":null,"funding_links":["https://github.com/sponsors/zircote"],"categories":[],"sub_categories":[],"readme":"# Documentation Review Plugin\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n[![Claude Code Plugin](https://img.shields.io/badge/Claude_Code-Plugin-blueviolet)](https://github.com/anthropics/claude-code)\n[![CI](https://github.com/zircote/documentation-review/actions/workflows/ci.yml/badge.svg)](https://github.com/zircote/documentation-review/actions/workflows/ci.yml)\n[![Version](https://img.shields.io/badge/version-0.1.0-green.svg)](https://github.com/zircote/documentation-review/releases)\n\nComprehensive documentation management for Claude Code: review, create, update, and maintain high-quality documentation.\n\n\u003c!-- Infographic: Visual summary of plugin capabilities --\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\".github/infographic.png\" alt=\"Documentation Review Plugin Overview\" width=\"800\"\u003e\n\u003c/p\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eView infographic generation prompt\u003c/summary\u003e\n\n```\nCreate a visual infographic summarizing the Documentation Review plugin for Claude Code.\n\nLayout: Clean, modern infographic style (1200x800px)\nBackground: Light cream/off-white with subtle texture\n\nSections:\n1. HEADER: \"Documentation Review\" - Claude Code Plugin for Documentation Excellence\n2. CORE CAPABILITIES (4 quadrants): Review, Create, Update, Cleanup\n3. SUPPORTED FORMATS: Markdown, MkDocs, Sphinx, Docusaurus, OpenAPI, AsyncAPI\n4. KEY COMMANDS: /doc-review → /doc-create → /doc-update → /doc-diataxis\n5. FOOTER: AI-Powered • MIT License • v0.1.0\n\nColor palette: Warm amber (#F59E0B), deep teal (#0D9488), coral (#F97316), cream (#FFFBEB)\nStyle: Professional, clean lines, rounded corners, subtle shadows\n```\n\n\u003c/details\u003e\n\n## Features\n\n- **Documentation Review** - Analyze existing docs for accuracy, completeness, and quality\n- **Documentation Creation** - Generate new docs from codebase analysis (README, API docs, templates)\n- **Documentation Updates** - Keep docs current with codebase changes\n- **Documentation Cleanup** - Identify obsolete or outdated content\n- **Diátaxis Framework** - Classify and audit docs against Diátaxis quadrants (tutorials, how-to, reference, explanation)\n- **Changelog Management** - Maintain CHANGELOG.md with Keep a Changelog format\n- **Quality Validation** - Automatic checks on markdown file edits\n- **Multi-format Support** - Markdown with awareness of MkDocs, Sphinx, Docusaurus\n- **API Documentation** - OpenAPI/Swagger and AsyncAPI integration\n\n## Installation\n\n### From GitHub\n\n```bash\nclaude plugin install zircote/documentation-review\n```\n\n### Manual Installation\n\nClone and add to Claude Code:\n\n```bash\ngit clone https://github.com/zircote/documentation-review.git\nclaude --plugin-dir /path/to/documentation-review\n```\n\nOr copy to your project's `.claude-plugin/` directory.\n\n## Commands\n\n| Command | Description |\n|---------|-------------|\n| `/doc-review [path]` | Review documentation for issues (file, directory, or project-wide) |\n| `/doc-create [type]` | Generate new documentation (readme, api, template) |\n| `/doc-update [path]` | Update outdated documentation with current information |\n| `/doc-cleanup` | Identify and report obsolete documentation |\n| `/doc-setup` | Interactive setup for project configuration |\n| `/doc-diataxis [action] [path]` | Analyze docs against Diátaxis framework (classify, review, gaps, audit) |\n\n## Agents\n\n| Agent | Description |\n|-------|-------------|\n| `doc-reviewer` | Comprehensive documentation audit with proactive triggering |\n| `doc-writer` | Content generation and documentation updates |\n\n## Skills\n\n- **documentation-standards** - Markdown best practices, structure guidelines, writing quality\n- **api-documentation** - OpenAPI/Swagger/AsyncAPI patterns and endpoint documentation\n- **changelog** - Keep a Changelog format, semantic-release, conventional commits mapping\n- **diataxis** - Diátaxis documentation framework quadrant classification and analysis\n\n## Configuration\n\nCreate `.claude/documentation-review.local.md` in your project root to customize behavior.\n\n### Quick Setup\n\nRun `/doc-setup` for interactive configuration, or manually create the file:\n\n```markdown\n---\n# Documentation paths to scan (default: auto-detect)\ndoc_paths:\n  - docs/\n  - README.md\n  - \"*.md\"\n\n# Files/patterns to ignore\nignore:\n  - \"**/node_modules/**\"\n  - \"**/vendor/**\"\n  - \"**/.git/**\"\n  - \"**/dist/**\"\n  - \"**/build/**\"\n  - \"CHANGELOG.md\"\n\n# Documentation standards\nstandards:\n  require_description: true\n  max_heading_depth: 4\n  require_code_examples: false\n  check_links: true\n  check_spelling: false\n\n# API documentation settings\napi_docs:\n  openapi_path: null           # Auto-detect\n  asyncapi_path: null          # Auto-detect\n  generate_from_code: false\n\n# Static site generator integration\nsite_generator:\n  type: auto                   # auto, mkdocs, sphinx, docusaurus\n  config_path: null            # Auto-detect\n\n# Output preferences\noutput:\n  verbosity: normal            # minimal, normal, detailed\n  format: markdown             # markdown, json\n---\n\n# Project Documentation Notes\n\nAdd project-specific documentation context here...\n```\n\n## File Structure\n\n```\ndocumentation-review/\n├── .claude-plugin/\n│   └── plugin.json\n├── agents/\n│   ├── doc-reviewer.md\n│   └── doc-writer.md\n├── commands/\n│   ├── doc-cleanup.md\n│   ├── doc-create.md\n│   ├── doc-diataxis.md\n│   ├── doc-review.md\n│   ├── doc-setup.md\n│   └── doc-update.md\n├── skills/\n│   ├── api-documentation/\n│   │   ├── SKILL.md\n│   │   ├── examples/\n│   │   └── references/\n│   ├── changelog/\n│   │   ├── SKILL.md\n│   │   ├── examples/\n│   │   └── references/\n│   ├── diataxis/\n│   │   ├── SKILL.md\n│   │   ├── examples/\n│   │   └── references/\n│   └── documentation-standards/\n│       ├── SKILL.md\n│       ├── examples/\n│       └── references/\n├── templates/\n│   └── documentation-review.local.md.example\n├── CHANGELOG.md\n├── LICENSE\n└── README.md\n```\n\n## Usage Examples\n\n### Review all project documentation\n```bash\n/doc-review\n```\n\n### Review specific file\n```bash\n/doc-review docs/api-reference.md\n```\n\n### Generate README from codebase\n```bash\n/doc-create readme\n```\n\n### Generate API documentation\n```bash\n/doc-create api\n```\n\n### Find outdated documentation\n```bash\n/doc-cleanup\n```\n\n### Classify docs against Diátaxis framework\n```bash\n/doc-diataxis classify docs/\n```\n\n### Audit documentation for Diátaxis coverage gaps\n```bash\n/doc-diataxis audit\n```\n\n## Contributing\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Submit a pull request\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzircote%2Fdocumentation-review","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzircote%2Fdocumentation-review","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzircote%2Fdocumentation-review/lists"}