-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Install links in readme #33
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
This does mean that the layout of the readme needs a change, moving to a table layout so that we keep better alighnment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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);
… auto-install-links
… auto-install-links
Merge blocked as file protocol handlers aren't supported on GitHub READMEs, we need to wait for a redirect link.