Skip to content

docs update#9408

Merged
danmoseley merged 3 commits intomicrosoft:mainfrom
danmoseley:docs
May 20, 2025
Merged

docs update#9408
danmoseley merged 3 commits intomicrosoft:mainfrom
danmoseley:docs

Conversation

@danmoseley
Copy link
Copy Markdown
Member

Description

Tweak markdowns in the repo

  1. Reference the official docs where they now exist.
  2. Avoid being Windows and Visual Studio centric.
  3. Remove api review process which we don't use. There is already an issue template to propose API.
  4. Update for folks who have moved out of the team.

Checklist

  • Is this feature complete?
    • Yes. Ready to ship.
    • No. Follow-up changes expected.
  • Are you including unit tests for the changes and scenario tests if relevant?
    • Yes
    • No
  • Did you add public API?
    • Yes
      • If yes, did you have an API Review for it?
        • Yes
        • No
      • Did you add <remarks /> and <code /> elements on your triple slash comments?
        • Yes
        • No
    • No
  • Does the change make any security assumptions or guarantees?
    • Yes
      • If yes, have you done a threat model and had a security review?
        • Yes
        • No
    • No
  • Does the change require an update in our Aspire docs?

Copilot AI review requested due to automatic review settings May 20, 2025 00:08
@github-actions github-actions Bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label May 20, 2025
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

This PR modernizes and streamlines the repository’s documentation by referencing official docs, de-emphasizing Windows/Visual Studio centric steps, removing deprecated API review guidance, and updating area ownership.

  • Redirect users to official .NET Aspire docs and clarify daily build setup
  • Refactor machine requirements to highlight VS Code, Visual Studio, and Codespaces without Windows-only bias
  • Remove the obsolete API review process doc and refresh CONTRIBUTING and area-owners files

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
docs/using-latest-daily.md Point to official docs, clarify daily build feed instructions
docs/machine-requirements.md Remove Windows-only VS instructions, add VS Code/DevContainers/Codespaces
docs/getting-perf-traces.md Add dotnet trace example, adjust headings and formatting
docs/contributing.md Reorder build/pack commands, clarify steps for shells and Visual Studio
docs/area-owners.md Update area owner handles
docs/api-review-process.md Delete deprecated API review process doc

Comment thread docs/using-latest-daily.md
Comment thread docs/machine-requirements.md Outdated
Comment thread docs/machine-requirements.md Outdated
Comment thread docs/area-owners.md Outdated
Comment thread docs/area-owners.md Outdated
@danmoseley danmoseley added area-engineering-systems infrastructure helix infra engineering repo stuff and removed needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners labels May 20, 2025
@danmoseley danmoseley enabled auto-merge (squash) May 20, 2025 02:00
@danmoseley danmoseley merged commit 7615e18 into microsoft:main May 20, 2025
497 of 500 checks passed
@danmoseley danmoseley deleted the docs branch May 20, 2025 20:16
@github-actions github-actions Bot locked and limited conversation to collaborators Jun 20, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-engineering-systems infrastructure helix infra engineering repo stuff

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants