docs: clarify HVE Core Extension vs Installer messaging across documentation#965
Merged
docs: clarify HVE Core Extension vs Installer messaging across documentation#965
Conversation
Correct documentation to clarify that hve-core is the flagship extension containing RPI workflow and core artifacts, while hve-core-all provides the complete set of all stable artifacts. - Fix broken extension ID hve-hve-core-installer to hve-installer - Rewrite install.md Quick Start with Extension vs Installer clarity - Add installer bridge section to extension.md with comparison table - Add Before You Customize capability matrix to customization docs - Insert cross-references across 6 documentation pages - Update all 6 clone method Quick Starts with installer mentions - Add Customization to Docusaurus navbar and footer navigation - Broaden installer skill scope to include installation methods - Replace all stable artifacts with flagship language on 9 role pages - Add hve-core-all references where complete artifact set is relevant
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
WilliamBerryiii
approved these changes
Mar 10, 2026
This was referenced Mar 10, 2026
WilliamBerryiii
pushed a commit
that referenced
this pull request
Mar 12, 2026
…ntation (#965) Corrected documentation across 28 files to clearly differentiate three products with overlapping names: the **HVE Core Extension** (flagship AI artifact library, zero config), the **HVE Core Installer** (guided setup companion with MCP auto-config and agent bundle copying), and **clone-based methods** (full artifact customization via direct file access). Removed inaccurate claims about Installer capabilities, added a customization capability matrix, and updated site navigation to help users choose the right installation method. > Documentation conflated the Extension with the Installer and made inaccurate claims about what the Installer provides (e.g., "select specific collections," "install collections independently"). The Installer copies agents by bundle and auto-configures MCP servers; it does not filter prompts, instructions, or skills. The updated language establishes consistent three-tier messaging: Extension (recommended) → Installer (guided setup + MCP) → Clone (full customization). ### Terminology and Positioning Updated language across all installation guides and 9 role-specific pages to replace "all stable artifacts" and "Full collection" with "flagship RPI workflow and core artifacts." The `hve-core` extension now consistently describes the flagship collection, while `hve-core-all` is referenced wherever the complete artifact library is relevant. - Renamed **"Full Collection"** heading to **"Flagship Collection"** and **"Collection Filtering"** to **"Agent Bundle Selection"** in *install.md* - Updated TIP boxes in all 9 role guides (*business-program-manager*, *data-scientist*, *engineer*, *new-contributor*, *security-architect*, *sre-operations*, *tech-lead*, *tpm*, *ux-designer*) with flagship language - Updated *ai-artifacts.md* extension packaging table from "Full / All stable artifacts" to "Flagship / RPI workflow and core artifacts" - Removed the "What HVE Core Does for You" heading in *engineer.md* (content preserved, integrated under Recommended Collections) ### Installer Skill Cross-References Added consistent references to the HVE Core Installer skill across getting-started, customization, and lifecycle documentation, establishing the installer as the recommended path for guided setup. - Added installer callout to *README.md* linking to the HVE Core Installer extension for guided setup and agent bundle selection - Added TIP box to *docs/README.md* distinguishing flagship and complete extension options - Updated all 6 clone method Quick Start sections (*peer-clone*, *submodule*, *git-ignored*, *multi-root*, *mounted*, *codespaces*) with a consistent three-tier pattern: extension first, then installer skill, then manual steps - Added new **"Need MCP Configuration or Guided Setup?"** section to *extension.md* with a capabilities comparison table - Rewritten *extension.md* Scenario 4 ("Want to Customize Later") to show progressive layering instead of uninstall-and-clone - Added TIP box to *mcp-configuration.md* referencing installer skill for auto MCP configuration - Updated *cli-plugins.md* installer plugin description with broader scope and extension link - Added "Not sure which method fits?" entry to *install.md* decision criteria - Updated new contributor guide step 3 to acknowledge both extension-only and clone-based installer paths ### Customization Documentation Introduced a capability matrix and starting-point guidance to help users understand what each installation type enables. - Added **"Before You Customize"** capability matrix to *customization/README.md* showing 8 customization levels across Extension Only, Installer Skill (Clone), and Direct Clone - Added **"Recommended Starting Point"** section to *team-adoption.md* guiding teams from flagship extension to installer to direct clone - Added IMPORTANT callout to *collections.md* clarifying that agent bundle selection copies agents only (prompts, instructions, and skills are not filtered by collection) ### Site Navigation - Added **Customization** links to both Docusaurus navbar and footer in *docusaurus.config.js* - Created *customization/_category_.json* at position 5 for Docusaurus navigation hierarchy ### Bug Fix - Fixed broken extension ID `hve-hve-core-installer` → `hve-installer` in *lifecycle/setup.md* ## Related Issue(s) Closes #964 ## Type of Change Select all that apply: **Code & Documentation:** * [ ] Bug fix (non-breaking change fixing an issue) * [ ] New feature (non-breaking change adding functionality) * [ ] Breaking change (fix or feature causing existing functionality to change) * [x] Documentation update **Infrastructure & Configuration:** * [ ] GitHub Actions workflow * [ ] Linting configuration (markdown, PowerShell, etc.) * [ ] Security configuration * [ ] DevContainer configuration * [ ] Dependency update **AI Artifacts:** * [ ] Reviewed contribution with `prompt-builder` agent and addressed all feedback * [ ] Copilot instructions (`.github/instructions/*.instructions.md`) * [ ] Copilot prompt (`.github/prompts/*.prompt.md`) * [ ] Copilot agent (`.github/agents/*.agent.md`) * [ ] Copilot skill (`.github/skills/*/SKILL.md`) **Other:** * [ ] Script/automation (`.ps1`, `.sh`, `.py`) * [ ] Other (please describe): ## Sample Prompts (for AI Artifact Contributions) <!-- Not applicable — no AI artifact changes in this PR --> ## Testing Automated validation commands run by the agent: * `npm run lint:md` — Passed (0 errors across 148 files) * `npm run spell-check` — Passed (0 issues across 239 files) * `npm run lint:frontmatter` — Passed (308 files validated, 0 errors) * `npm run validate:skills` — Passed (5 skills, 0 errors) * `npm run lint:md-links` — Passed (all links resolved) * `npm run lint:ps` — Passed (all PowerShell files clean) * `npm run plugin:generate` — Passed (11 plugins generated, no formatting changes) * `npm run lint:links` — Passed (no URLs with language paths) Security analysis: no sensitive data, credentials, dependency changes, or privilege modifications detected. All changes are documentation-only. Diff-based assessment: verified all 28 changed files exist, confirmed broken extension ID fix (`hve-hve-core-installer` → `hve-installer`), confirmed consistent terminology across role guides and clone method pages. Manual testing was not performed. ## Checklist ### Required Checks * [x] Documentation is updated (if applicable) * [x] Files follow existing naming conventions * [x] Changes are backwards compatible (if applicable) (N/A — documentation-only changes) * [ ] Tests added for new functionality (if applicable) (N/A — no testable functionality added) ### AI Artifact Contributions <!-- Not applicable — no AI artifact changes in this PR --> * [ ] Used `/prompt-analyze` to review contribution * [ ] Addressed all feedback from `prompt-builder` review * [ ] Verified contribution follows common standards and type-specific requirements ### Required Automated Checks The following validation commands must pass before merging: * [x] Markdown linting: `npm run lint:md` * [x] Spell checking: `npm run spell-check` * [x] Frontmatter validation: `npm run lint:frontmatter` * [x] Skill structure validation: `npm run validate:skills` * [x] Link validation: `npm run lint:md-links` * [x] PowerShell analysis: `npm run lint:ps` * [x] Plugin freshness: `npm run plugin:generate` ## Security Considerations <!--⚠️ WARNING: Do not commit sensitive information such as API keys, passwords, or personal data --> * [x] This PR does not contain any sensitive or NDA information * [ ] Any new dependencies have been reviewed for security issues (N/A — no dependency changes) * [ ] Security-related scripts follow the principle of least privilege (N/A — no security scripts modified) ## Additional Notes - All changes are documentation-only (markdown files and one Docusaurus JS config file). No code, workflow, or AI artifact changes. - Agent bundle selection remains scoped to agents only; collection-based filtering of prompts, instructions, and skills is noted as future work in multiple locations.
This was referenced Mar 12, 2026
This was referenced Mar 15, 2026
WilliamBerryiii
added a commit
that referenced
this pull request
Mar 20, 2026
🤖 I have created a release *beep* *boop* --- ## [3.2.0](hve-core-v3.1.46...hve-core-v3.2.0) (2026-03-20) ### ✨ Features * add -OutputPath parameter to Validate-MarkdownFrontmatter.ps1 ([#1134](#1134)) ([fdf1bcf](fdf1bcf)), closes [#1006](#1006) * add action version consistency scan workflow ([#1127](#1127)) ([4229df1](4229df1)) * **agent:** MVE Experiment Designer ([#976](#976)) ([70f86ca](70f86ca)) * **agents:** add ADO Backlog Manager orchestrator agent ([#800](#800)) ([fae3987](fae3987)) * **agents:** add meeting analyst agent for transcript analysis using work-iq ([#502](#502)) ([5345b5b](5345b5b)) * **agents:** add quick-reference line to RPI Phase 5 suggestions ([#897](#897)) ([9a90f39](9a90f39)) * **agents:** add RAI Planner, enhance SSSC Planner, and redesign Security Planner ([#979](#979)) ([06f826c](06f826c)) * **agents:** add symmetric cross-system handoff to GitHub Backlog Manager ([#952](#952)) ([ba34a35](ba34a35)) * **agents:** Functional Code Review Agent — pre-PR functional correctness reviewer ([#733](#733)) ([9cf63b7](9cf63b7)) * **build:** add Python extensions and uv 0.10.8 to devcontainer ([#920](#920)) ([9ca0579](9ca0579)) * **build:** add uv ecosystem to Dependabot configuration ([#913](#913)) ([2a4bd39](2a4bd39)) * **build:** enable npm pinning enforcement in dependency scan ([#838](#838)) ([4e9e31f](4e9e31f)) * **build:** migrate attestation actions to v4.1.0 and add SBOM verification docs ([#841](#841)) ([ca1e65b](ca1e65b)) * **collections:** add four new validator checks (orphan, duplicate, companion, coverage) ([#869](#869)) ([1a96b73](1a96b73)) * **devcontainer,security:** add enterprise artifact hub configuration ([#1032](#1032)) ([1d56d25](1d56d25)) * **docs:** add Rust coding standards and guidelines ([#809](#809)) ([d4c4899](d4c4899)) * **extension:** add Microsoft logo icon to VS Code Marketplace listings ([#906](#906)) ([82aca41](82aca41)) * **github:** add declarative label management ([#953](#953)) ([a1a6845](a1a6845)) * **instructions:** add ADO backlog shared infrastructure ([#786](#786)) ([1914078](1914078)) * **instructions:** add ADO backlog sprint planning and capacity tracking ([#788](#788)) ([d6fb77d](d6fb77d)) * **instructions:** add ADO triage workflow and prompt ([#787](#787)) ([cde0190](cde0190)) * **instructions:** add shared story quality conventions and sprint planning ([#803](#803)) ([a2f18e3](a2f18e3)) * **prompts:** add ADO discovery and work item prompts with agent routing ([#790](#790)) ([7e74523](7e74523)) * **prompts:** add security review prompts ([#1118](#1118)) ([ad30967](ad30967)) * **scripts:** add dynamic Python skill discovery for lint/test ([#957](#957)) ([0a90f57](0a90f57)) * **scripts:** add Get-StandardTimestamp utility to CIHelpers module ([#1126](#1126)) ([b273a4b](b273a4b)) * **scripts:** add Python copyright header validation ([#905](#905)) ([67df902](67df902)) * **scripts:** add Python skill support to Validate-SkillStructure ([#903](#903)) ([68479d9](68479d9)) * **scripts:** add workflow npm command scanning to dependency pinning ([#837](#837)) ([6b5ae06](6b5ae06)) * **security:** add basic security reviewer agent with owasp skills ([#1008](#1008)) ([cb1fd05](cb1fd05)) * **security:** add sigstore attestation bundles and fix component-detection action ([#1148](#1148)) ([f79c272](f79c272)) * **skills:** add Atheris fuzz harness with CI workflow integration ([#1102](#1102)) ([d337e1d](d337e1d)) * **skills:** add PowerPoint automation skill with YAML-driven deck generation ([#868](#868)) ([00465cd](00465cd)) * **skills:** convert hve-core-installer agent to self-contained skill ([#846](#846)) ([1d821fb](1d821fb)) * **skills:** enhance pr-reference skill with flexible filtering and base branch detection ([#1095](#1095)) ([26a32ea](26a32ea)) * **workflows:** add devcontainer infrastructure change log workflow ([#899](#899)) ([8aca446](8aca446)) * **workflows:** add milestone auto-close on stable and pre-release publishes ([#834](#834)) ([79362b1](79362b1)) * **workflows:** add ms.date documentation freshness checking ([#969](#969)) ([3ed441c](3ed441c)) * **workflows:** add Python linting CI workflow with Ruff ([#951](#951)) ([f89f0eb](f89f0eb)) * **workflows:** add Python testing CI workflow with pytest and Codecov ([#934](#934)) ([5e8306f](5e8306f)) * **workflows:** add uv and Python package sync to copilot-setup-steps ([#921](#921)) ([45d517d](45d517d)) ### 🐛 Bug Fixes * **build:** override Linguist vendored flag for Python skill files ([#1155](#1155)) ([0eee5b6](0eee5b6)) * **build:** override serialize-javascript to >=7.0.3 for RCE fix ([#876](#876)) ([e49039a](e49039a)) * **build:** resolve Pinned-Dependencies alerts for vsce npm commands in extension workflows ([#782](#782)) ([89dad9d](89dad9d)) * **build:** update undici and yauzl overrides for security audit ([#1030](#1030)) ([2c2f92f](2c2f92f)) * **docs:** add CLI Plugins to install.md navigation surfaces ([#902](#902)) ([79d6595](79d6595)) * **docs:** add sidebar ordering for Design Thinking documentation ([#832](#832)) ([551fddc](551fddc)), closes [#830](#830) * **docs:** graduate design-thinking to preview and correct stale collection references ([#831](#831)) ([5110e35](5110e35)) * **docs:** include project-planning in UX Designer install guidance ([#908](#908)) ([e7aa9bc](e7aa9bc)) * **docs:** remediate writing-style convention violations ([#865](#865)) ([68b04bc](68b04bc)) * **docs:** remove draft content announcement banner ([#825](#825)) ([b45de80](b45de80)) * **docs:** remove unbounded path-to-regexp override breaking SSG ([#1153](#1153)) ([d810018](d810018)) * **docs:** use actual clone paths instead of folder display names in multi-root workspace settings ([#984](#984)) ([5dbab82](5dbab82)) * **instructions:** replace black with ruff in uv-projects ([#898](#898)) ([b0c06d9](b0c06d9)) * **scripts:** cover .github/ skill files in copyright header validation ([#1055](#1055)) ([#1098](#1098)) ([27fbd33](27fbd33)) * **scripts:** eliminate phantom git changes from plugin generation ([#1035](#1035)) ([e49a1b5](e49a1b5)) * **scripts:** enable JSON log output for lint:version-consistency ([#1033](#1033)) ([52b0885](52b0885)) * **security:** calculate compliance score from total scanned dependencies ([#930](#930)) ([c112c3d](c112c3d)) * **skills:** add AST validation and namespace restriction for content-extra.py ([#1027](#1027)) ([c50c7a3](c50c7a3)) * **skills:** add depth limits to recursive PowerPoint processing functions ([#1028](#1028)) ([bf08994](bf08994)) * **skills:** harden XML parsing and blob writes in powerpoint extract ([#1053](#1053)) ([89d24b1](89d24b1)) * **skills:** resolve ruff lint and format violations in powerpoint skill ([#1048](#1048)) ([17bbe7a](17bbe7a)) * **workflows:** add uv.lock dependencies submission have fork-skip condition ([#1109](#1109)) ([dec56ac](dec56ac)) * **workflows:** automate weekly SHA staleness check with issue creation ([#975](#975)) ([1ea4caa](1ea4caa)) * **workflows:** close Codecov integration gaps for Pester and pytest flags ([#1106](#1106)) ([cca29b7](cca29b7)) * **workflows:** propagate uv sync errors in copilot-setup-steps ([#961](#961)) ([df88d7c](df88d7c)) * **workflows:** resolve release-please skip cascade and Python project discovery ([#1043](#1043)) ([79993e2](79993e2)) * **workflows:** scan only commit subjects for breaking change detection ([#1157](#1157)) ([a38a657](a38a657)) ### 📚 Documentation * clarify HVE Core Extension vs Installer messaging across documentation ([#965](#965)) ([0fceb8f](0fceb8f)) * **docs:** add ADO integration user documentation ([#935](#935)) ([ec89302](ec89302)) * **docs:** add Project Planning agent documentation ([#936](#936)) ([3a3a0fd](3a3a0fd)) * **onboarding:** overhaul marketplace onboarding and documentation site ([#982](#982)) ([4309e10](4309e10)) ### ♻️ Refactoring * **build:** merge code-review collection into coding-standards ([#863](#863)) ([8027e7b](8027e7b)) * **workflows:** rename release pipeline workflows and add marketplace automation triggers ([#829](#829)) ([b6397f4](b6397f4)) ### 🔧 Maintenance * **build:** add clean:logs npm script ([#1122](#1122)) ([f85fe02](f85fe02)), closes [#988](#988) * **build:** add JSON reporter for cspell ([#1123](#1123)) ([6d59f67](6d59f67)) * **ci:** add multi-arch support to copilot-setup-steps binary downloads ([#955](#955)) ([8d0c706](8d0c706)) * **deps-dev:** bump cspell from 9.6.4 to 9.7.0 in the npm-dependencies group ([#839](#839)) ([3fa16ff](3fa16ff)) * **deps:** bump actions/dependency-review-action from 4.8.3 to 4.9.0 in the github-actions group across 1 directory ([#942](#942)) ([1a9b858](1a9b858)) * **deps:** bump cairosvg from 2.8.2 to 2.9.0 in /.github/skills/experimental/powerpoint ([#1025](#1025)) ([f4deda7](f4deda7)) * **deps:** bump dompurify from 3.3.1 to 3.3.2 in /docs/docusaurus ([#924](#924)) ([d2060d6](d2060d6)) * **deps:** bump svgo from 3.3.2 to 3.3.3 in /docs/docusaurus ([#880](#880)) ([6dc2406](6dc2406)) * **deps:** bump the github-actions group across 1 directory with 4 updates ([#1100](#1100)) ([2290dc0](2290dc0)) * **deps:** bump the github-actions group with 6 updates ([#840](#840)) ([f57bc01](f57bc01)) * **docs:** correct New-MsDateReport table rendering and refresh stale docs ([#1114](#1114)) ([c2b806f](c2b806f)) * **settings:** remove orphaned Checkov config and stale gitignore entries ([#870](#870)) ([98fcd74](98fcd74)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: hve-core-release-please[bot] <254602402+hve-core-release-please[bot]@users.noreply.github.com> Co-authored-by: Bill Berry <wberry@microsoft.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.
Description
Corrected documentation across 28 files to clearly differentiate three products with overlapping names: the HVE Core Extension (flagship AI artifact library, zero config), the HVE Core Installer (guided setup companion with MCP auto-config and agent bundle copying), and clone-based methods (full artifact customization via direct file access). Removed inaccurate claims about Installer capabilities, added a customization capability matrix, and updated site navigation to help users choose the right installation method.
Terminology and Positioning
Updated language across all installation guides and 9 role-specific pages to replace "all stable artifacts" and "Full collection" with "flagship RPI workflow and core artifacts." The
hve-coreextension now consistently describes the flagship collection, whilehve-core-allis referenced wherever the complete artifact library is relevant.Installer Skill Cross-References
Added consistent references to the HVE Core Installer skill across getting-started, customization, and lifecycle documentation, establishing the installer as the recommended path for guided setup.
Customization Documentation
Introduced a capability matrix and starting-point guidance to help users understand what each installation type enables.
Site Navigation
Bug Fix
hve-hve-core-installer→hve-installerin lifecycle/setup.mdRelated Issue(s)
Closes #964
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
Automated validation commands run by the agent:
npm run lint:md— Passed (0 errors across 148 files)npm run spell-check— Passed (0 issues across 239 files)npm run lint:frontmatter— Passed (308 files validated, 0 errors)npm run validate:skills— Passed (5 skills, 0 errors)npm run lint:md-links— Passed (all links resolved)npm run lint:ps— Passed (all PowerShell files clean)npm run plugin:generate— Passed (11 plugins generated, no formatting changes)npm run lint:links— Passed (no URLs with language paths)Security analysis: no sensitive data, credentials, dependency changes, or privilege modifications detected. All changes are documentation-only.
Diff-based assessment: verified all 28 changed files exist, confirmed broken extension ID fix (
hve-hve-core-installer→hve-installer), confirmed consistent terminology across role guides and clone method pages.Manual testing was not performed.
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:generateSecurity Considerations
Additional Notes