Skip to content

feat: Add Project Documenter Plugin with agents and skills#1436

Open
parveen-dotnet wants to merge 1 commit intogithub:stagedfrom
parveen-dotnet:feature/project-documenter-plugin
Open

feat: Add Project Documenter Plugin with agents and skills#1436
parveen-dotnet wants to merge 1 commit intogithub:stagedfrom
parveen-dotnet:feature/project-documenter-plugin

Conversation

@parveen-dotnet
Copy link
Copy Markdown

  • 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

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have read and followed the Guidance for submissions involving paid services.
  • My contribution adds a new plugin, instruction, prompt, agent, skill, or workflow file in the correct directory.
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested my instructions, prompt, agent, skill, or workflow with GitHub Copilot.
  • I have run npm start and verified that README.md is up to date.
  • I am targeting the staged branch 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:

  • Markdown document — 10-section project summary with embedded diagram references
  • Draw.io diagrams — C4 Context, Pipeline, and Component relationship diagrams (.drawio + .drawio.png)
  • Word document — professionally formatted .docx with title page, table of contents, and embedded PNG architecture images

Key Features

  • 🏗️ Auto-Discovery — Scans repository to understand technology stack, architecture patterns, and code structure
  • 📊 Professional Diagrams — Creates C4 Model architecture diagrams (Context, Container, Component levels)
  • 📄 Word Export — Converts Markdown to formatted .docx with embedded PNG images
  • 🔄 Multi-Language Support — Works with .NET, Java, Node.js, Python, Go, Rust, and more
  • 🎯 Technology Agnostic — Auto-detects frameworks, databases, messaging systems, and CI/CD platforms

What's Included

  • 1 Agent: project-documenter — orchestrates the entire documentation generation workflow
  • 2 Skills:
    • drawio — generates C4 diagrams and exports to PNG
    • md-to-docx — converts Markdown to Word with embedded images

Output

Generated files include:

  • docs/project-summary.md — Source Markdown document
  • docs/project-summary.docx — Word document with embedded diagrams
  • docs/diagrams/ — Editable .drawio files + rendered .drawio.png exports

Type of Contribution

  • New instruction file.
  • New prompt file.
  • New agent file.
  • New plugin.
  • New skill file.
  • New agentic workflow.
  • Update to existing instruction, prompt, agent, plugin, skill, or workflow.
  • Other (please specify):

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

copilot plugin install project-documenter@awesome-copilot
---

By submitting this pull request, I confirm that my contribution abides by the [Code of Conduct](../CODE_OF_CONDUCT.md) and will be licensed under the MIT License.

- 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
@github-actions
Copy link
Copy Markdown
Contributor

🔍 Skill Validator Results

⚠️ Warnings or advisories found

Scope Checked
Skills 2
Agents 1
Total 3
Severity Count
--- ---:
❌ Errors 0
⚠️ Warnings 1
ℹ️ Advisories 0

Summary

Level Finding
ℹ️ 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))
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)) ```

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.

1 participant