Skip to content

feat: Simplify docs, make them more concise and hand-review for accuracy #11

Open
danOIntellitect wants to merge 6 commits intomainfrom
olvera/docs-review
Open

feat: Simplify docs, make them more concise and hand-review for accuracy #11
danOIntellitect wants to merge 6 commits intomainfrom
olvera/docs-review

Conversation

@danOIntellitect
Copy link
Copy Markdown
Collaborator

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] [2] [3] [4] [5] [6] [7] [8]

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] [2]

Content Corrections and Improvements:

  • Updated skill documentation in Coalesce Accelerator to use dotnet coalesce instead of the deprecated coalesce_generate command. [1] [2]
  • Improved the overview and organization of the C# Best Practices plugin README, clarifying the language description and adding missing section headers. [1] [2] [3] [4]

Metadata Consistency:

  • Minor formatting and consistency improvements in plugin manifest fields, such as the categories array in plugin.json.

danOIntellitect and others added 4 commits April 28, 2026 10:03
- 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
@danOIntellitect danOIntellitect self-assigned this Apr 28, 2026
Copilot AI review requested due to automatic review settings April 28, 2026 17:49
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.01.0.1, and normalize some manifest formatting (e.g., categories arrays).
  • Simplify/condense multiple plugin READMEs and SKILL docs; remove the standalone XUnit prompt + the “Prompts” docs section.
  • Enhance generate-ai-tuning-docs.ps1 to 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.

Comment thread plugins/solid-principles/skills/apply-solid/SKILL.md Outdated
Comment thread plugins/vuetify-components/README.md Outdated
Comment thread docs/index.md Outdated
Comment thread plugins/coalesce-accelerator/README.md Outdated
danOIntellitect and others added 2 commits April 28, 2026 10:56
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@danOIntellitect danOIntellitect enabled auto-merge (squash) April 28, 2026 20:23
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.

2 participants