Skip to content

Improve deployment overview and CI/CD guidance#720

Merged
IEvangelist merged 5 commits intomainfrom
docs/cicd-section
Apr 16, 2026
Merged

Improve deployment overview and CI/CD guidance#720
IEvangelist merged 5 commits intomainfrom
docs/cicd-section

Conversation

@davidfowl
Copy link
Copy Markdown
Contributor

@davidfowl davidfowl commented Apr 15, 2026

Summary

  • add a workflow-first CI/CD overview page and reorganize the deployment navigation around the pipeline model, CI/CD, and targets
  • rewrite the deployment overview around the pipeline model, clarify publish vs deploy, and explain compute environments, parameters, and environments together
  • refresh the deployment landing page, pipelines overview, and example lifecycle workflow to match the new terminology and guidance
  • refine deployment nav labeling, expand CI/CD on first mention, and style hero inline code to match the topic accent
  • update the doc-writer skill to require visible C# and TypeScript AppHost examples

Validation

  • pnpm --dir ./src/frontend run lint
  • pnpm --dir ./src/frontend run test:unit:docs
  • pnpm --dir ./src/frontend run test:unit:components

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 15, 2026 17:26
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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

Comment thread src/frontend/src/content/docs/deployment/overview.mdx
Comment thread src/frontend/src/content/docs/deployment/overview.mdx
Comment thread src/frontend/src/content/docs/deployment/overview.mdx Outdated
Comment thread src/frontend/src/content/docs/deployment/overview.mdx
Comment thread src/frontend/src/content/docs/deployment/app-lifecycle.mdx Outdated
Comment thread src/frontend/config/sidebar/deployment.topics.ts
Comment thread src/frontend/src/content/docs/deployment/index.mdx Outdated
davidfowl and others added 2 commits April 15, 2026 10:45
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Comment thread src/frontend/config/sidebar/deployment.topics.ts Outdated
Comment thread src/frontend/src/content/docs/deployment/ci-cd.mdx Outdated
Comment thread src/frontend/src/components/TopicHero.astro
Copy link
Copy Markdown
Member

@IEvangelist IEvangelist left a comment

Choose a reason for hiding this comment

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

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.

Image

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>
@davidfowl
Copy link
Copy Markdown
Contributor Author

@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 Overview heading, and replaced the AppHost language pivots with Tabs/TabItem. I also added the TypeScript note explaining that the custom builder.pipeline APIs aren't supported there yet. If you'd prefer Aspire pipeline over Pipeline model, I can make that follow-up too.

@IEvangelist IEvangelist merged commit 9620e9f into main Apr 16, 2026
5 checks passed
@IEvangelist IEvangelist deleted the docs/cicd-section branch April 16, 2026 01:53
JamesNK pushed a commit that referenced this pull request Apr 21, 2026
* 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>
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