Refactor: update README to enhance GitHub Copilot usage instructions …#6
Refactor: update README to enhance GitHub Copilot usage instructions …#6robpitcher wants to merge 1 commit intomainfrom
Conversation
…and add appendix for customizations
There was a problem hiding this comment.
Pull request overview
This pull request refactors the README.md to improve the documentation structure and user experience for GitHub Copilot customizations. The changes move from a reference-first approach to a more action-oriented "Try it out" workflow, making it easier for new users to get started.
Changes:
- Renamed "Getting Started" to "Try it out" with streamlined step-by-step instructions for testing Copilot customizations
- Moved the GitHub Copilot customizations reference table to a new "Appendix" section
- Enhanced the "Extras" section with clearer guidance for creating custom prompts and using the GitHub Copilot Coding Agent
| 1. Run `az login` to authenticate to Azure and select your desired subscription. | ||
|
|
||
| 2. Run `az login` to authenticate to Azure and select your desired subscription. | ||
| 2. Run the prompt template by typing `/demo-vm iacLanguage:bicep` or `/demo-vm iacLanguage:terraform` into GitHub Copilot Chat |
There was a problem hiding this comment.
Missing period at the end of this sentence. The instruction should end with a period for consistency with other numbered steps.
| 2. Run the prompt template by typing `/demo-vm iacLanguage:bicep` or `/demo-vm iacLanguage:terraform` into GitHub Copilot Chat | |
| 2. Run the prompt template by typing `/demo-vm iacLanguage:bicep` or `/demo-vm iacLanguage:terraform` into GitHub Copilot Chat. |
|
|
||
| or | ||
|
|
||
| Try delegating IaC creation to GitHub Copilot Coding Agent: |
There was a problem hiding this comment.
The formatting in this section is inconsistent. Line 25 presents a standalone suggestion ending with a period, while line 29 introduces a multi-step process with a colon. Consider restructuring for consistency, either by making both options follow the same format (both ending with colons leading to steps) or by making them parallel standalone statements.
| Try delegating IaC creation to GitHub Copilot Coding Agent: | |
| Try delegating IaC creation to GitHub Copilot Coding Agent. |
This pull request updates the
README.mdto make the getting started instructions easier to follow and separates out the documentation of GitHub Copilot customizations into a dedicated appendix section. The changes clarify the workflow for testing Copilot customizations and provide better guidance for new users.Improvements to onboarding and workflow clarity:
Documentation organization: