fix(docs): improve language consistency in Automated Installation section (#139)

WilliamBerryiii · web-flow · commit a9329184105d · 2025-12-15T09:35:18.000-08:00
# Pull Request ## Description Refines the Automated Installation section of README.md for improved clarity and consistency. Changes include removing redundant words, fixing product name casing, and using more precise action verbs. ## Related Issue(s) Fixes #138 ## 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` chatmode and addressed all feedback - [ ] Copilot instructions (`.github/instructions/*.instructions.md`) - [ ] Copilot prompt (`.github/prompts/*.prompt.md`) - [ ] Copilot chatmode (`.github/chatmodes/*.chatmode.md`) **Other:** - [ ] Script/automation (`.ps1`, `.sh`, `.py`) - [ ] Other (please describe): ## Testing Verified markdown renders correctly with changes applied. ## Checklist ### Required Checks - [x] Documentation is updated (if applicable) - [x] Files follow existing naming conventions - [x] Changes are backwards compatible (if applicable) ### 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] Link validation: `npm run lint:md-links` - [ ] PowerShell analysis: `npm run lint:ps` (N/A - no PowerShell changes) ## Security Considerations - [x] This PR does not contain any sensitive or NDA information - [x] Any new dependencies have been reviewed for security issues - [x] Security-related scripts follow the principle of least privilege ## Additional Notes Changes made: * Removed redundant "automatically" (already implied by heading) * Fixed "Agent list" → "agent list" for consistent casing * Changed "Say:" → "Enter:" for more precise action * Fixed "HVE-Core" → "HVE Core" to match project naming * Removed redundant "in GitHub Copilot Chat pane" * Changed "After the agent is installed:" → "After installing the agent:" for active voice
diff --git a/README.md b/README.md
@@ -17,8 +17,6 @@ estimated_reading_time: 2
 
 An open-source library of Hypervelocity Engineering components that accelerates Azure solution development by enabling advanced conversational workflows.
 
-[![Install HVE Core](https://img.shields.io/badge/Install_HVE_Core-007ACC?style=for-the-badge&logo=visualstudiocode&logoColor=white)](https://aka.ms/install-hve-core) [![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=for-the-badge&logo=visualstudiocode&logoColor=white)](https://aka.ms/install-hve-core-insiders)
-
 **Quick Install:** Automated installation via the `hve-core-installer` agent in VS Code (~30 seconds)
 
 ## Overview
@@ -29,11 +27,15 @@ HVE Core provides a unified set of optimized GitHub Copilot and Microsoft 365 Co
 
 ### Automated Installation
 
-**Recommended:** Use the `hve-core-installer` agent for automated setup:
+**Recommended:** Use the buttons below to install the `hve-core-installer` agent in your project for fully automated setup:
+
+[![Install HVE Core](https://img.shields.io/badge/Install_HVE_Core-007ACC?style=for-the-badge&logo=visualstudiocode&logoColor=white)](https://aka.ms/install-hve-core) [![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=for-the-badge&logo=visualstudiocode&logoColor=white)](https://aka.ms/install-hve-core-insiders)
+
+After installing the agent:
 
 1. Open GitHub Copilot Chat in VS Code (Ctrl+Alt+I)
-2. Select `hve-core-installer` from Agent list in GitHub Copilot Chat pane
-3. Say: "Install HVE-Core into my project"
+2. Select `hve-core-installer` from the agent list
+3. Enter: "Install HVE Core into my project"
 4. Follow the guided installation
 
 The installer will:
