Install links in readme#33
Merged
Merged
Conversation
This does mean that the layout of the readme needs a change, moving to a table layout so that we keep better alighnment
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds VS Code and VS Code Insiders install badges to both the generated instructions in the code and the static listings in README.md.
- Introduces
makeBadges(link)to generate markdown badges for installation. - Refactors
generateInstructionsSection,generatePromptsSection, andgenerateChatModesSectionto output tables including an “Install” column. - Updates
README.mdto replace bulleted lists with tables that include the new install badges.
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| update-readme.js | Added makeBadges function and updated generators to include a table “Install” column using badges. |
| README.md | Replaced list entries with markdown tables for instructions, prompts, and chat modes including install badges. |
Comments suppressed due to low confidence (4)
update-readme.js:261
- [nitpick] The alt text for the second badge is identical to the first (
Install in VS Code). Consider labeling itInstall in VS Code Insidersto accurately describe the badge.
return `[](vscode:chat-prompt/install?url=https://raw.githubusercontent.com/github/awesome-copilot/main/${link}) [](vscode-insiders:chat-prompt/install?url=https://raw.githubusercontent.com/github/awesome-copilot/main/${link})`;
update-readme.js:290
- The variable
linkis not defined in this scope before callingmakeBadges(link). You need to compute or pass the correct relative file path (e.g.,const link = ...) before generating badges.
const badges = makeBadges(link);
update-readme.js:331
- The variable
linkis undefined here as well. Ensure you definelink(for exampleconst link = path.join('prompts', file)) before generating badges.
const badges = makeBadges(link);
update-readme.js:380
linkis not declared in this function’s scope. Definelink(e.g.,const link = path.join('chatmodes', file)) before callingmakeBadges.
const badges = makeBadges(link);
jamesmontemagno
approved these changes
Jul 3, 2025
… auto-install-links
… auto-install-links
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.
Merge blocked as file protocol handlers aren't supported on GitHub READMEs, we need to wait for a redirect link.