feat: Add Project Documenter Plugin with agents and skills#1436
Open
parveen-dotnet wants to merge 1 commit intogithub:stagedfrom
Open
feat: Add Project Documenter Plugin with agents and skills#1436parveen-dotnet wants to merge 1 commit intogithub:stagedfrom
parveen-dotnet wants to merge 1 commit intogithub:stagedfrom
Conversation
- Auto-discovers technology stack and project structure - Generates architecture diagrams with draw.io - Creates professional Word (.docx) output with embedded PNG images - Includes agents for orchestration and skills for functionality
Contributor
🔍 Skill Validator Results
Summary
Full validator output```text Found 2 skill(s) [drawio] 📊 drawio: 913 BPE tokens [chars/4: 793] (detailed ✓), 13 sections, 3 code blocks [md-to-docx] 📊 md-to-docx: 672 BPE tokens [chars/4: 679] (detailed ✓), 9 sections, 3 code blocks [md-to-docx] ⚠ No numbered workflow steps — agents follow sequenced procedures more reliably. ✅ All checks passed (2 skill(s)) ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist
npm startand verified thatREADME.mdis up to date.stagedbranch for this pull request.Description
This PR introduces the Project Documenter Plugin, a comprehensive solution for automatically generating professional project documentation.
What It Does
Point the agent at any repository and it produces:
.drawio+.drawio.png).docxwith title page, table of contents, and embedded PNG architecture imagesKey Features
.docxwith embedded PNG imagesWhat's Included
project-documenter— orchestrates the entire documentation generation workflowdrawio— generates C4 diagrams and exports to PNGmd-to-docx— converts Markdown to Word with embedded imagesOutput
Generated files include:
docs/project-summary.md— Source Markdown documentdocs/project-summary.docx— Word document with embedded diagramsdocs/diagrams/— Editable.drawiofiles + rendered.drawio.pngexportsType of Contribution
Additional Notes
Supported Technologies
Auto-detects: .NET, Java, Node.js, Python, Go, Rust, Docker, Kubernetes, GitHub Actions, SQS, RabbitMQ, Kafka, and more.
Architecture Model
Follows C4 Model for generating Context, Container, and Component level diagrams.
Installation