Improve deployment overview and CI/CD guidance#720
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the deployment documentation to a pipeline-first model, adding CI/CD guidance and reorganizing navigation to better separate pipeline concepts, CI/CD workflows, and target-specific deployment docs.
Changes:
- Rewrites deployment overview content around pipeline entry points, compute environments, parameters, and environments.
- Adds a new “CI/CD overview” page and updates related cross-links and terminology across deployment docs.
- Reorganizes the deployment sidebar into clearer groupings (Pipelines, CI/CD, Targets).
Show a summary per file
| File | Description |
|---|---|
| src/frontend/src/content/docs/deployment/overview.mdx | Rewrites the deployment overview with pipeline model concepts, language-parity AppHost examples, and “Continue learning” cards. |
| src/frontend/src/content/docs/deployment/index.mdx | Updates landing-page subtitle to reflect publish vs deploy positioning. |
| src/frontend/src/content/docs/deployment/environments.mdx | Updates LearnMore links to emphasize the new CI/CD overview and the lifecycle example. |
| src/frontend/src/content/docs/deployment/ci-cd.mdx | Adds a new workflow-first CI/CD overview page with guidance on env/parameter flow and command choice. |
| src/frontend/src/content/docs/deployment/app-lifecycle.mdx | Renames/reframes the lifecycle doc as a worked CI/CD workflow example and aligns terminology. |
| src/frontend/config/sidebar/deployment.topics.ts | Reorganizes deployment navigation into Pipelines, CI/CD, and target groupings; renames labels. |
| .github/skills/doc-writer/SKILL.md | Tightens doc-writer requirements to always show both C# and TypeScript AppHost samples (when available). |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 7/7 changed files
- Comments generated: 7
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
IEvangelist
left a comment
There was a problem hiding this comment.
I think we need to change the top-level sidebar name from "Pipelines" to something else. Right now, it reads like Azure Pipelines, or that's where my head went, specially seeing CI/CD at the same level. It's almost like we need a different name there.
Also, since you're making these changes could you please fix the pipelines overview doc? It has an overview heading that should be renamed, as we get an overview in the TOC for free.
Also, it uses pivots and it should instead use Tabs/TabItem for the apphost languages. And in the empty tab for TS, we should have a note to the user explaining that TS doesn't have those APIs supported yet.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
@IEvangelist Addressed in 7be90b1. I renamed the sidebar group to Pipeline model to avoid the Azure Pipelines/CI-CD ambiguity, renamed the pipelines page's redundant |
* Refine deployment docs and CI/CD guidance Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address PR review feedback Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix lifecycle FileTree example Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address follow-up PR feedback Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Refine pipeline docs from review feedback Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Summary
Validation