Skip to content

Commit c2ddb52

Browse files
danOIntellitectCopilotCopilot
authored
feat: Simplify docs, make them more concise and hand-review for accuracy (#11)
This pull request primarily updates plugin versions to 1.0.1 across the marketplace and plugin manifests, and streamlines documentation for clarity and maintainability. It removes redundant or outdated documentation sections, simplifies plugin overviews, and clarifies available skills and integration points for the Coalesce Accelerator plugin. Minor content improvements and corrections are also included. **Version Updates:** - Incremented the version from 1.0.0 to 1.0.1 for the overall marketplace and all individual plugins in `.github/plugin/marketplace.json` and `plugins/coalesce-accelerator/plugin.json`. [[1]](diffhunk://#diff-1f0f8287689a50a4b4e815821ff6c9d321349f4d036c5c405c6893f6994514b3L9-R9) [[2]](diffhunk://#diff-1f0f8287689a50a4b4e815821ff6c9d321349f4d036c5c405c6893f6994514b3L19-R19) [[3]](diffhunk://#diff-1f0f8287689a50a4b4e815821ff6c9d321349f4d036c5c405c6893f6994514b3L34-R34) [[4]](diffhunk://#diff-1f0f8287689a50a4b4e815821ff6c9d321349f4d036c5c405c6893f6994514b3L43-R43) [[5]](diffhunk://#diff-1f0f8287689a50a4b4e815821ff6c9d321349f4d036c5c405c6893f6994514b3L59-R59) [[6]](diffhunk://#diff-1f0f8287689a50a4b4e815821ff6c9d321349f4d036c5c405c6893f6994514b3L74-R74) [[7]](diffhunk://#diff-1f0f8287689a50a4b4e815821ff6c9d321349f4d036c5c405c6893f6994514b3L90-R90) [[8]](diffhunk://#diff-8a2172839b78396b2b485fdc8d2c90dc84105e2ea041f97a625198f0d4e22bfdL5-R5) **Documentation and Content Simplification:** - Overhauled the `plugins/coalesce-accelerator/README.md`: - Replaced lengthy workflow and scenario sections with concise lists of available skills, tools, prompts, and resources. - Added clear instructions for MCP server integration and linked to relevant documentation. - Moved related plugin links to a dedicated section. - Removed the "Instructions" and "Prompts" sections from the main documentation index and table of contents, focusing the docs on contribution and core resources. [[1]](diffhunk://#diff-b4d68dc855d0f9476d3f2ee343853bd21bf82ea9960d0cf06661baa244439dd6L11-R14) [[2]](diffhunk://#diff-8762905fa91074c951a7b405c32efd6a876513d520d419a00e622046259b68c0L27-L32) **Content Corrections and Improvements:** - Updated skill documentation in Coalesce Accelerator to use `dotnet coalesce` instead of the deprecated `coalesce_generate` command. [[1]](diffhunk://#diff-eab1153c59e284db860552f8108d88c4223af592e45f55fb47a6a9ca5ea02fd1L43-R45) [[2]](diffhunk://#diff-55fb5a7f5c5bb836f920c54c9bb45d09b14b20d6348e1ae8298dbf35e32fdffdL28-R28) - Improved the overview and organization of the C# Best Practices plugin README, clarifying the language description and adding missing section headers. [[1]](diffhunk://#diff-e74afc47ef0ef154d75c23696744ee0648b78afee95ab335ffb1b6cfaba8be67L7-L15) [[2]](diffhunk://#diff-e74afc47ef0ef154d75c23696744ee0648b78afee95ab335ffb1b6cfaba8be67R24) [[3]](diffhunk://#diff-e74afc47ef0ef154d75c23696744ee0648b78afee95ab335ffb1b6cfaba8be67R34) [[4]](diffhunk://#diff-e74afc47ef0ef154d75c23696744ee0648b78afee95ab335ffb1b6cfaba8be67R46) **Metadata Consistency:** - Minor formatting and consistency improvements in plugin manifest fields, such as the `categories` array in `plugin.json`. --------- Co-authored-by: Copilot <copilot@github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent afbcc5b commit c2ddb52

31 files changed

Lines changed: 715 additions & 7253 deletions

File tree

.github/plugin/marketplace.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
},
77
"metadata": {
88
"description": "Curated Copilot plugins for enterprise C# development, Coalesce framework, and Vue 3 with Vuetify. Designed to support SOLID principles, best practices, and architectural excellence.",
9-
"version": "1.0.0",
9+
"version": "1.0.1",
1010
"homepage": "https://intellitect.github.io/IntelliPlugins",
1111
"repository": "https://github.com/IntelliTect/IntelliPlugins",
1212
"license": "MIT"
@@ -16,7 +16,7 @@
1616
"name": "solid-principles",
1717
"displayName": "SOLID Principles & Architecture",
1818
"description": "Enterprise-grade guidance on SOLID principles, architecture patterns, and code quality for maintainable C# projects.",
19-
"version": "1.0.0",
19+
"version": "1.0.1",
2020
"category": "Enterprise",
2121
"source": "./plugins/solid-principles",
2222
"keywords": [
@@ -31,7 +31,7 @@
3131
"name": "testing-essentials",
3232
"displayName": "Testing Essentials",
3333
"description": "Comprehensive testing best practices including unit testing strategies, test naming conventions, and mock frameworks.",
34-
"version": "1.0.0",
34+
"version": "1.0.1",
3535
"category": "Enterprise",
3636
"source": "./plugins/testing-essentials",
3737
"keywords": ["testing", "unit-tests", "TDD", "best-practices", "xUnit"]
@@ -40,7 +40,7 @@
4040
"name": "csharp-best-practices",
4141
"displayName": "C# Best Practices",
4242
"description": "C#-specific language patterns, naming conventions, error handling, dependency injection, and async best practices.",
43-
"version": "1.0.0",
43+
"version": "1.0.1",
4444
"category": "Language",
4545
"source": "./plugins/csharp-best-practices",
4646
"keywords": [
@@ -56,7 +56,7 @@
5656
"name": "coalesce-accelerator",
5757
"displayName": "Coalesce Accelerator",
5858
"description": "Streamline full-stack Coalesce framework development with code generation, data binding, and EF Core migration workflows.",
59-
"version": "1.0.0",
59+
"version": "1.0.1",
6060
"category": "Framework",
6161
"source": "./plugins/coalesce-accelerator",
6262
"keywords": [
@@ -71,7 +71,7 @@
7171
"name": "vuetify-components",
7272
"displayName": "Vuetify Components & Patterns",
7373
"description": "Vue 3 and Vuetify best practices for building professional UI components with accessibility and UX consistency.",
74-
"version": "1.0.0",
74+
"version": "1.0.1",
7575
"category": "Framework",
7676
"source": "./plugins/vuetify-components",
7777
"keywords": [
@@ -87,7 +87,7 @@
8787
"name": "enterprise-bug-fixing",
8888
"displayName": "Enterprise Bug Fixing Workflow",
8989
"description": "Structured bug resolution workflow with test-first approach, Azure DevOps integration, and comprehensive validation.",
90-
"version": "1.0.0",
90+
"version": "1.0.1",
9191
"category": "Specialized",
9292
"source": "./plugins/enterprise-bug-fixing",
9393
"keywords": [

docs/index.md

Lines changed: 2 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -8,52 +8,10 @@ Get started with IntelliPlugins in minutes:
88

99
1. **[Installation Guide](plugins/installation-guide.md)** - Set up plugins in your environment
1010
2. **[Getting Started](guides/getting-started.md)** - Your first steps with Copilot plugins
11-
3. **[Instructions](instructions/index.md)** - One-click install coding standards for VS Code
12-
4. **[Prompts](prompts/index.md)** - One-click install reusable prompt files for VS Code
1311

14-
## Available Plugins
12+
## Contributing
1513

16-
### Enterprise-Generic Plugins
17-
18-
These plugins apply best practices across any C# project:
19-
20-
- **[SOLID Principles & Architecture](plugins/solid-principles.md)** - Enterprise-grade architecture patterns
21-
- **[Testing Essentials](plugins/testing-essentials.md)** - Comprehensive testing best practices
22-
- **[C# Best Practices](plugins/csharp-best-practices.md)** - Language-specific patterns and conventions
23-
24-
### Framework-Specific Plugins
25-
26-
Tools optimized for IntelliTect's tech stack:
27-
28-
- **[Coalesce Accelerator](plugins/coalesce-accelerator.md)** - Full-stack Coalesce development productivity
29-
- **[Vuetify Components](plugins/vuetify-components.md)** - Vue 3 & Vuetify UI patterns
30-
31-
### Specialized Plugins
32-
33-
Domain-specific workflows:
34-
35-
- **[Enterprise Bug Fixing](plugins/enterprise-bug-fixing.md)** - Structured bug resolution with Azure DevOps
36-
37-
## Guides & Resources
38-
39-
- **[Getting Started](guides/getting-started.md)** - New to Copilot plugins?
40-
- **[Usage Examples](guides/usage-examples.md)** - Real-world scenarios and patterns
41-
42-
## Instructions & Prompts
43-
44-
Lightweight Copilot files you can install directly into VS Code with one click — no copy-pasting required.
45-
46-
- **[Instructions](instructions/index.md)** - Automatically apply coding standards to matching files (e.g., C# conventions on `**/*.cs`)
47-
- **[Prompts](prompts/index.md)** - Reusable prompt templates for common workflows (e.g., XUnit best practices)
48-
49-
## Key Features
50-
51-
**Enterprise Focus** - Built for SOLID principles and architectural excellence
52-
**Coalesce Optimized** - Streamline full-stack development
53-
**Vue 3 Ready** - Modern Vue and Vuetify patterns
54-
**Test-First** - Emphasis on quality and testing
55-
**One-Click Install** - Instructions and prompts install directly into VS Code
56-
**Open Source** - Community-driven, MIT licensed
14+
Have ideas for new content or improvements? Open a PR or [open an issue](https://github.com/IntelliTect/IntelliPlugins/issues).
5715

5816
## Resources
5917

docs/toc.yml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,6 @@
2424
href: instructions/index.md
2525
- name: C# Development
2626
href: instructions/csharp.md
27-
- name: Prompts
28-
items:
29-
- name: Overview
30-
href: prompts/index.md
31-
- name: XUnit Best Practices
32-
href: prompts/csharp-xunit.md
3327
- name: Guides
3428
items:
3529
- name: Getting Started

0 commit comments

Comments
 (0)