Add technology-agnostic blueprint generators for comprehensive project documentation #113
Conversation
…ion that helps GitHub Copilot to generate instructions that respect project-specific conventions - Add architecture-blueprint-generator for documenting system design patterns - Add code-exemplars-blueprint-generator for identifying quality code standards - Add copilot-instructions-blueprint-generator for creating AI guidance files - Add folder-structure-blueprint-generator for documenting project organization - Add project-workflow-blueprint-generator for end-to-end process documentation - Add readme-blueprint-generator for comprehensive repository documentation - Add technology-stack-blueprint-generator for tech stack analysis
|
@zooav - thanks for the contributions! Can you please run 'node update-readme.js' locally and commit the change? This way the new prompts show up in the overall readme. Thanks! |
@codemillmatt done, kindly review again, thanks. |
|
it is done. please check one more time, thanks
…On Tue, Jul 22, 2025 at 1:40 PM Matt Soucoup ***@***.***> wrote:
*codemillmatt* left a comment (github/awesome-copilot#113)
<#113 (comment)>
@zooav <https://github.com/zooav> - thanks for the contributions!
Can you please run 'node update-readme.js' locally and commit the change?
This way the new prompts show up in the overall readme.
Thanks!
—
Reply to this email directly, view it on GitHub
<#113 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ADAKMBH6TU2UTVW4R736CZ33JZZQJAVCNFSM6AAAAACB5AU7R2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTCMBUGA2DAOJZGM>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
|
Hi @zooav - My bad - it's there. Thanks for helping out here - we appreciate it! |
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a comprehensive collection of 7 technology-agnostic blueprint generators that enable teams to automatically analyze and document their codebases. The generators help create standardized documentation across different technology stacks while maintaining consistency and following best practices.
- Adds 7 blueprint generator prompts covering architecture, code exemplars, copilot instructions, folder structure, project workflow, README generation, and technology stack analysis
- Updates README.md with entries for all new blueprint generators
- Provides technology-agnostic solutions that auto-detect project types (.NET, Java, JavaScript, React, Python, etc.)
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| prompts/architecture-blueprint-generator.prompt.md | Comprehensive architecture documentation generator with configurable analysis depth and diagram generation |
| prompts/code-exemplars-blueprint-generator.prompt.md | Code quality exemplars identification tool with multi-language support and categorization options |
| prompts/copilot-instructions-blueprint-generator.prompt.md | GitHub Copilot instruction file generator that analyzes existing codebase patterns |
| prompts/folder-structure-blueprint-generator.prompt.md | Project organization documentation tool with visualization and naming convention analysis |
| prompts/project-workflow-analysis-blueprint-generator.prompt.md | End-to-end workflow documentation generator covering entry points to data access |
| prompts/readme-blueprint-generator.prompt.md | README.md generator that analyzes .github/copilot directory documentation |
| prompts/technology-stack-blueprint-generator.prompt.md | Technology stack analysis and documentation tool with version detection |
| README.md | Updated with 7 new prompt entries maintaining alphabetical order |
codemillmatt
left a comment
There was a problem hiding this comment.
Marking as changes requested as per copilot.
Fixed : The description field in the front matter should be wrapped in single quotes, not double quotes, according to the coding guidelines.
Fixed : The description field in the front matter should be wrapped in single quotes, not double quotes, according to the coding guidelines.
Fixed : The description field in the front matter should be wrapped in single quotes, not double quotes, according to the coding guidelines.
Fixed : The description field in the front matter should be wrapped in single quotes, not double quotes, according to the coding guidelines.
|
@codemillmatt Requested changes are done. please check one more time, thanks. |
Add technology-agnostic blueprint generators for comprehensive project documentation that helps GitHub Copilot to generate instructions that respect project-specific conventions.
Pull Request Checklist
node update-readme.jsand verified thatREADME.mdis up to date.Description
Overview
This PR introduces a collection of 7 technology-agnostic blueprint generators that enable teams to automatically analyze and document their codebases comprehensively. These prompts help generate standardized documentation across different technology stacks while maintaining consistency and following best practices.
What's Included
Key Features
Usage Context
These generators are designed to help development teams:
Benefits
Type of Contribution
Additional Notes
Technical Implementation
${VARIABLE}) for customization*-blueprint-generator.prompt.md)Integration
Future Enhancements
How to use Parameterized Prompts with Github Copilot Chat
Start your prompt by declaring the variables, then reference the template:
Example:
Set these variables:
Then analyze the codebase using the template from the active document.
By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.