feat: Simplify docs, make them more concise and hand-review for accuracy #11
Open
danOIntellitect wants to merge 6 commits intomainfrom
Open
feat: Simplify docs, make them more concise and hand-review for accuracy #11danOIntellitect wants to merge 6 commits intomainfrom
danOIntellitect wants to merge 6 commits intomainfrom
Conversation
- Remove agents directory and its README from enterprise-bug-fixing plugin. - Update version to 1.0.1 in enterprise-bug-fixing and solid-principles plugins. - Clean up README.md in solid-principles plugin with formatting improvements and additional content. - Modify plugin.json files for solid-principles and testing-essentials plugins to streamline categories. - Enhance SKILL.md files in solid-principles and testing-essentials plugins with better structure and examples. - Remove csharp-xunit prompt file in favor of the testing essentials plugin
…t, enhance clarity, and consolidate sections on core patterns, lifecycle hooks, and best practices. Co-authored-by: Copilot <copilot@github.com>
…oc.yml; enhance instructions generation in script
There was a problem hiding this comment.
Pull request overview
This PR bumps IntelliPlugins marketplace + plugin manifest versions to 1.0.1 and significantly streamlines several plugin docs/skills (especially Coalesce Accelerator and Vuetify Components), while also updating the docs TOC generation script to optionally remove empty TOC sections.
Changes:
- Bump plugin + marketplace versions from
1.0.0→1.0.1, and normalize some manifest formatting (e.g.,categoriesarrays). - Simplify/condense multiple plugin READMEs and SKILL docs; remove the standalone XUnit prompt + the “Prompts” docs section.
- Enhance
generate-ai-tuning-docs.ps1to remove TOC sections when there’s no generated content.
Reviewed changes
Copilot reviewed 31 out of 31 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/generate-ai-tuning-docs.ps1 | Allows TOC sections to be removed when instructions/prompts are absent; formatting tweaks. |
| prompts/csharp-xunit.prompt.md | Removed XUnit prompt content (prompt system being de-emphasized/removed). |
| plugins/vuetify-components/skills/use-composition-api/SKILL.md | Condensed Composition API guidance to a shorter “core patterns” format. |
| plugins/vuetify-components/skills/scaffold-component/SKILL.md | Simplified scaffold guidance and references. |
| plugins/vuetify-components/skills/add-accessibility/SKILL.md | Condensed accessibility guidance into key requirements/checklist + refs. |
| plugins/vuetify-components/plugin.json | Version bump + categories formatting normalization. |
| plugins/vuetify-components/README.md | Major README simplification + “Skills/Reference” structure. |
| plugins/testing-essentials/skills/write-unit-tests/SKILL.md | Adds expanded xUnit project setup/migration guidance. |
| plugins/testing-essentials/skills/apply-testing-patterns/SKILL.md | Minor whitespace/formatting cleanup + added “Test Organization” section. |
| plugins/testing-essentials/plugin.json | Version bump + categories formatting normalization. |
| plugins/testing-essentials/README.md | Updates testing framework section and minor formatting/content improvements. |
| plugins/solid-principles/skills/apply-solid/SKILL.md | Formatting edits and attempted applyTo addition (currently problematic). |
| plugins/solid-principles/plugin.json | Version bump + categories formatting normalization. |
| plugins/solid-principles/README.md | Formatting/content simplification and modernization of DI example. |
| plugins/enterprise-bug-fixing/plugin.json | Version bump + categories formatting normalization. |
| plugins/enterprise-bug-fixing/agents/README.md | Removed agents directory README. |
| plugins/enterprise-bug-fixing/agents/BugFixerAgent.agent.md | Reformats tools list and improves readability of workflow docs. |
| plugins/enterprise-bug-fixing/README.md | Removes Coalesce-specific regeneration sections; general streamlining. |
| plugins/csharp-best-practices/skills/review-async/SKILL.md | Formatting tweaks and clarifications around ConfigureAwait guidance. |
| plugins/csharp-best-practices/plugin.json | Version bump + categories formatting normalization. |
| plugins/csharp-best-practices/README.md | Simplifies README and updates language/platform statements + references. |
| plugins/coalesce-accelerator/skills/setup-coalesce-project/SKILL.md | Replaces long workflow doc with concise “new project / existing project” steps and dotnet coalesce. |
| plugins/coalesce-accelerator/skills/scaffold-entity/SKILL.md | Updates generation command references and trims large reference sections. |
| plugins/coalesce-accelerator/skills/run-code-generation/SKILL.md | Replaces coalesce_generate guidance with concise dotnet coalesce docs + config. |
| plugins/coalesce-accelerator/skills/generate-migration/SKILL.md | Updates generation command to dotnet coalesce. |
| plugins/coalesce-accelerator/skills/add-data-source/SKILL.md | Updates generation command to dotnet coalesce. |
| plugins/coalesce-accelerator/plugin.json | Version bump + categories formatting normalization. |
| plugins/coalesce-accelerator/README.md | Major README simplification + MCP server integration notes + references. |
| docs/toc.yml | Removes Prompts section from docs TOC. |
| docs/index.md | Removes large plugin catalog listing; replaces with short Contributing section. |
| .github/plugin/marketplace.json | Marketplace metadata + per-plugin version bumps to 1.0.1. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
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:
.github/plugin/marketplace.jsonandplugins/coalesce-accelerator/plugin.json. [1] [2] [3] [4] [5] [6] [7] [8]Documentation and Content Simplification:
plugins/coalesce-accelerator/README.md:Content Corrections and Improvements:
dotnet coalesceinstead of the deprecatedcoalesce_generatecommand. [1] [2]Metadata Consistency:
categoriesarray inplugin.json.