Skip to content

fix(readme): Update install badges to use vscode.dev/redirect pattern #113

@WilliamBerryiii

Description

@WilliamBerryiii

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):

  1. aka.ms links should redirect to https://vscode.dev/redirect?url=<encoded-vscode-uri>
  2. 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-core pointing to vscode.dev/redirect with VS Code URI
  • Create aka.ms link install-hve-core-insiders pointing 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/vscodehttps://vscode.dev/redirect?url=vscode:mcp/install...

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions