-
Notifications
You must be signed in to change notification settings - Fork 125
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
Problem
GitHub sanitizes custom URI schemes (like vscode: and vscode-insiders:) in markdown links for security reasons. The current README install badges link to https://aka.ms/install-hve-core and https://aka.ms/install-hve-core-insiders, but these aka.ms links need to be configured to work around GitHub's sanitization.
Solution
Use the vscode.dev/redirect pattern (discovered from github/awesome-copilot repository):
- aka.ms links should redirect to
https://vscode.dev/redirect?url=<encoded-vscode-uri> - vscode.dev/redirect then redirects to the actual
vscode:URI
aka.ms Configuration Required
VS Code (Regular):
- Short URL:
https://aka.ms/install-hve-core - Target URL:
https://vscode.dev/redirect?url=vscode%3Achat-agent%2Finstall%3Furl%3Dhttps%253A%252F%252Fraw.githubusercontent.com%252Fmicrosoft%252Fhve-core%252Frefs%252Fheads%252Fmain%252F.github%252Fgithub-copilot-library.json
VS Code Insiders:
- Short URL:
https://aka.ms/install-hve-core-insiders - Target URL:
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%252Fgithub-copilot-library.json
Acceptance Criteria
- Create aka.ms link
install-hve-corepointing to vscode.dev/redirect with VS Code URI - Create aka.ms link
install-hve-core-insiderspointing to vscode.dev/redirect with VS Code Insiders URI - Verify badges work when clicked from GitHub README
- Verify VS Code opens and prompts to install the chat agent
References
- Pattern source: github/awesome-copilot README badges
- Working example:
https://aka.ms/awesome-copilot/mcp/vscode→https://vscode.dev/redirect?url=vscode:mcp/install...
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request