docs: improve new user onboarding with terminology, CLI plugins, and collections clarity#1520
docs: improve new user onboarding with terminology, CLI plugins, and collections clarity#1520
Conversation
…collections clarity - add HVE/RPI definitions, component-type callout, and one-click install badges to README - add CLI plugin install path to Quick Start and Choose Your Extension sections - add post-install usage guide with named commands vs agent mode to cli-plugins.md - add collections disambiguation callout and decision aid to install.md - add "After Installing a Collection" section to collections.md 📚 - Generated by Copilot
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1520 +/- ##
==========================================
- Coverage 87.44% 87.43% -0.01%
==========================================
Files 68 68
Lines 10335 10335
==========================================
- Hits 9037 9036 -1
- Misses 1298 1299 +1
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Advisory review — this PR is from a maintainer. Findings are informational only.
Overview
Well-structured documentation PR that directly addresses the user research findings from #1519. The changes are well-scoped, the descriptions are clear, and the CLI post-install guidance fills a real gap. Three content accuracy issues and a checklist compliance gap are noted below.
Issue Alignment ✅
The PR links to #1519 as "Related to" (appropriate if the issue stays open for further follow-up). Changes address the stated research findings: terminology definitions, CLI post-install documentation, and the naming disambiguation. Coverage looks thorough.
PR Template Compliance ⚠️
Several Required Automated Checks are unchecked without an (N/A — reason) annotation:
| Check | Relevance to this PR |
|---|---|
npm run lint:frontmatter |
Docs files carry frontmatter — directly applicable |
npm run lint:md-links |
Links added throughout — directly applicable |
npm run docs:test |
Docusaurus content changed — directly applicable |
npm run plugin:generate |
N/A for docs-only, but annotation is missing |
Per the template: "When a conditional checkbox's trigger condition is not met, annotate the checkbox inline with (N/A — {brief reason})." Please either run the applicable commands and check the boxes, or add explicit N/A annotations for the ones that genuinely don't apply.
Coding Standards ✅
Writing style is clear, professional, and consistent with the repo conventions. Docusaurus admonition syntax is used correctly. Mermaid <br/> line breaks follow the documented pattern.
Code Quality Findings
Three inline comments are attached. Summary:
-
install.mdline 73 — The NOTE callout recommends the flagship HVE Core extension for most users, but the existing README text (line 65) and the decision aid directly below (line 89) both recommend HVE Core All for new/exploratory users. The three recommendations are inconsistent and will confuse first-time readers. -
install.mdline 83 —C1 --> C2in the Mermaid diagram implies the flagship collection leads to domain collections, which misrepresents the architecture. Both collections are independent branches from the repository; the All Extension packages them together. -
install.mdline 71 — The disambiguation NOTE lists 3 of the 4 contexts the PR description says were identified as colliding. The CLI plugin context (hve-coreas a plugin name) is missing.
No Security Concerns ✅
Documentation-only change. No credentials, no secrets, no executable code introduced.
Note
🔒 Integrity filter blocked 1 item
The following item were blocked because they don't meet the GitHub integrity level.
- #1519
issue_read: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
To allow these resources, lower min-integrity in your GitHub frontmatter:
tools:
github:
min-integrity: approved # merged | approved | unapproved | none| > | ||
| > * **Repository** (`microsoft/hve-core`) - source for all 221 artifacts | ||
| > * **Extension** (`HVE Core`) - installs the flagship collection (41 artifacts) | ||
| > * **Extension** (`HVE Core All`) - installs all collections (221 artifacts) |
There was a problem hiding this comment.
Disambiguation is incomplete — The PR description states the research identified "a critical naming collision where 'hve-core' is used in 4 distinct contexts," but this NOTE callout only disambiguates three. The CLI plugin context is missing.
Consider adding a fourth bullet:
> * **CLI plugin** (`hve-core`) - installable via `copilot plugin install hve-core@hve-core`Without this entry, users installing via CLI will still encounter the same naming confusion the PR aims to resolve.
Co-authored-by: Copilot <copilot@github.com>
- specify CLI plugin installation command - differentiate between flagship and all collections for user clarity 🔍 - Generated by Copilot Co-authored-by: Copilot <copilot@github.com>
Description
Improved the new user experience across the README, getting started docs, and CLI plugin documentation based on user research findings. The research identified 18 unanswered questions after reading the README, a critical naming collision where "hve-core" is used in 4 distinct contexts, and zero documentation on how to use agents after CLI plugin installation.
README Improvements
vscode:extension/URI scheme for both flagship and all-collections extensionsCLI Post-Install Usage (docs/getting-started/methods/cli-plugins.md)
/agent <name>Collections Disambiguation (docs/getting-started/install.md)
Post-Install Activation (docs/getting-started/collections.md)
Related Issue(s)
Related to #1519
Type of Change
Select all that apply:
Code & Documentation:
Infrastructure & Configuration:
AI Artifacts:
prompt-builderagent and addressed all feedback.github/instructions/*.instructions.md).github/prompts/*.prompt.md).github/agents/*.agent.md).github/skills/*/SKILL.md)Other:
.ps1,.sh,.py)Sample Prompts (for AI Artifact Contributions)
Testing
Checklist
Required Checks
AI Artifact Contributions
/prompt-analyzeto review contributionprompt-builderreviewRequired Automated Checks
The following validation commands must pass before merging:
npm run lint:mdnpm run spell-checknpm run lint:frontmatternpm run validate:skillsnpm run lint:md-linksnpm run lint:psnpm run plugin:generatenpm run docs:testSecurity Considerations