Commit 868f655
authored
fix(docs): update install badges to use aka.ms redirect URLs (#114)
# Pull Request
## Description
Update README install badges to use aka.ms short links instead of raw
`vscode:` URI schemes. GitHub sanitizes custom URI schemes in markdown
for security reasons, causing the install badges to not work when
clicked.
The fix uses the pattern: `aka.ms` → `vscode.dev/redirect` → `vscode:`
URI
This is the official Microsoft pattern for VS Code extension install
links on GitHub, as documented in
[github/awesome-copilot](https://github.com/github/awesome-copilot).
## Related Issue(s)
Fixes #113
## 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 badges render correctly in GitHub README preview
- [ ] Tested aka.ms links redirect to vscode.dev/redirect (pending
aka.ms link creation)
- [ ] Confirmed vscode.dev/redirect properly triggers VS Code install
**Note:** aka.ms short links must be created in the aka.ms portal with
the following targets:
- `https://aka.ms/install-hve-core` →
`https://vscode.dev/redirect?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%253A%252F%252Fraw.githubusercontent.com%252Fmicrosoft%252Fhve-core%252Frefs%252Fheads%252Fmain%252F.github%252Fagents%252Fhve-core-installer.agent.md`
- `https://aka.ms/install-hve-core-insiders` →
`https://vscode.dev/redirect?url=vscode-insiders%3Achat-agent%2Finstall%3Furl%3Dhttps%253A%252F%252Fraw.githubusercontent.com%252Fmicrosoft%252Fhve-core%252Frefs%252Fheads%252Fmain%252F.github%252Fagents%252Fhve-core-installer.agent.md`
## 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:
- [ ] Markdown linting: `npm run lint:md`
- [ ] Spell checking: `npm run spell-check`
- [ ] Frontmatter validation: `npm run lint:frontmatter`
- [ ] Link validation: `npm run lint:md-links`
- [ ] PowerShell analysis: `npm run lint:ps`
## 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
The vscode.dev/redirect service is Microsoft's official solution for
handling custom URI schemes on platforms that sanitize them (like
GitHub). This pattern is used by the official GitHub Copilot
awesome-list.
🔗 - Generated by Copilot1 parent c3af708 commit 868f655
1 file changed
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
17 | 17 | | |
18 | 18 | | |
19 | 19 | | |
20 | | - | |
| 20 | + | |
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
| |||
0 commit comments