Skip to content

docs: add Create New Project with Copilot guide and support runbook - #1644

Open
Nathan (nturinski) wants to merge 5 commits into
feat/CoRfrom
docs/copilot-create-project
Open

docs: add Create New Project with Copilot guide and support runbook#1644
Nathan (nturinski) wants to merge 5 commits into
feat/CoRfrom
docs/copilot-create-project

Conversation

@nturinski

Copy link
Copy Markdown
Member

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.

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.
@nturinski
Nathan (nturinski) requested a review from a team as a code owner August 3, 2026 22:31
@nturinski

Copy link
Copy Markdown
Member Author

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md covering the full CoR pipeline, UI surfaces, artifacts/state, and support runbook.
  • Add docs/images/copilot-create-project/README.md describing screenshot naming/capture expectations for the guide.
  • Add .github/instructions/copilot-on-rails-docs.instructions.md to 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.md is **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/instructions file 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.

Comment thread docs/copilot-create-project.md Outdated
Comment thread docs/copilot-create-project.md Outdated
Comment thread docs/copilot-create-project.md Outdated
- [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)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot Remove the part 6 in general. It was removed from the document as it was a placeholder.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Nathan (nturinski) and others added 3 commits August 4, 2026 11:19
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants