docs: add Create New Project with Copilot guide and support runbook - #1644
docs: add Create New Project with Copilot guide and support runbook#1644Nathan (nturinski) wants to merge 5 commits into
Conversation
Adds docs/copilot-create-project.md (end-user guide + support/triage runbook for the Copilot on Rails feature) with centered screenshots for every stage and support surface, plus a .github/instructions rule to keep the doc in sync when the feature changes.
|
I recommend mostly looking at it via view file: https://github.com/microsoft/vscode-azureresourcegroups/blob/5a24c084f9260385bdc6331596abbb853056c516/docs/copilot-create-project.md |
There was a problem hiding this comment.
Pull request overview
Adds a comprehensive end-user guide plus support/triage runbook for the “Create New Project with Copilot” (Copilot on Rails) flow in the Azure Resources extension, along with supporting screenshot-folder guidance and a repo instruction to keep the doc updated when the feature changes.
Changes:
- Add
docs/copilot-create-project.mdcovering the full CoR pipeline, UI surfaces, artifacts/state, and support runbook. - Add
docs/images/copilot-create-project/README.mddescribing screenshot naming/capture expectations for the guide. - Add
.github/instructions/copilot-on-rails-docs.instructions.mdto require doc updates alongside CoR feature changes.
Reviewed changes
Copilot reviewed 3 out of 18 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/images/copilot-create-project/README.md | Adds guidance for storing and naming screenshots referenced by the new guide. |
| docs/copilot-create-project.md | New end-user + support/triage runbook documentation for Copilot on Rails, with UI references and troubleshooting. |
| .github/instructions/copilot-on-rails-docs.instructions.md | Adds a scoped Copilot instruction rule to keep the doc in sync with feature changes and flag stale screenshots. |
Suppressed comments (3)
docs/copilot-create-project.md:192
- This sentence says approval flips the plan to
Status: Approved, but the plan file’s metadata key is**Status**:(e.g.**Status**: Approved). Keeping the exact marker consistent matters because the plan preview parser and agent instructions treat these metadata rows as a contract.
Approving flips the plan to `Status: Approved` and hands off to **`azure-project-scaffold`** via the
`start_project_scaffold` tool.
docs/copilot-create-project.md:470
- The escalation checklist references the autopilot artifact marker as
executionMode: auto, but the recorded marker in.azure/project-plan.mdis**Execution Mode**: auto. Using the exact string helps support reliably confirm whether autopilot was active.
5. Whether **autopilot** was active (`[AUTOPILOT MODE]` marker or `executionMode: auto`).
docs/copilot-create-project.md:473
- The images README and the
.github/instructionsfile both refer to a “Part 6 — Screenshot capture checklist” section in this guide, but the section is missing. Adding it will fix the broken link target and provide a single authoritative list of expected screenshot filenames.
---
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - [Re‑download agent instructions](#re-download-agent-instructions) | ||
| - [Reset a workspace's state](#reset-a-workspaces-state) | ||
| - [Escalation checklist](#escalation-checklist) | ||
| - [Appendix — reference tables](#appendix--reference-tables) |
There was a problem hiding this comment.
Copilot Remove the part 6 in general. It was removed from the document as it was a placeholder.
There was a problem hiding this comment.
Updated in commit e944c29. I removed the stale Part 6 reference from the instruction file and aligned the remaining metadata literals in the guide (**Status**, **Execution Mode**: auto).
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: nturinski <5290572+nturinski@users.noreply.github.com>
Adds docs/copilot-create-project.md (end-user guide + support/triage runbook for the Copilot on Rails feature) with centered screenshots for every stage and support surface.
Plus a .github/instructions rule to keep the doc in sync when the feature changes.