Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Aug 6, 2025

The current .NET installation documentation uses a shared include file verify-download-macos-linux.md that attempts to handle both Linux and macOS checksum validation in a single file. This approach creates unnecessary complexity and makes the documentation harder to maintain.

This PR replaces the shared include approach with platform-specific content directly in each article:

Changes made:

  • Removed the shared include file docs/core/install/includes/verify-download-macos-linux.md
  • Updated docs/core/install/linux-scripted-manual.md with Linux-specific instructions using sha512sum commands
  • Updated docs/core/install/macos.md with macOS-specific instructions using shasum -a 512 commands
  • Improved example file names to be platform-appropriate (linux-x64 vs osx-x64)

Benefits:

  • Each platform article now contains only relevant instructions for its target audience
  • Eliminates the complexity of a shared include that tried to handle multiple platforms
  • Makes the documentation easier to maintain and update per platform
  • Provides clearer, more focused guidance for users on each platform

Platform-specific commands:

  • Linux: sha512sum and sha512sum -c {file} --ignore-missing
  • macOS: shasum -a 512 and shasum -a 512 -c {file}

Both commands produce identical SHA512 checksums for validation, but use the native tools available on each platform.

Fixes #47112.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.


Internal previews

📄 File 🔗 Preview link
docs/core/install/linux-scripted-manual.md docs/core/install/linux-scripted-manual
docs/core/install/macos.md docs/core/install/macos

Copilot AI changed the title [WIP] Missing macOS-specific checksum validation instructions Add macOS-specific checksum validation instructions for .NET installation Aug 6, 2025
Copilot AI requested a review from adegeo August 6, 2025 19:07
@adegeo
Copy link
Contributor

adegeo commented Aug 6, 2025

@copilot Instead of the changes you made, can you actually port this into the individual articles that reference the include file, then remove the include file? Adjust the include file's content to be specific to platform covered by the article. So the macos.md file would use content from verify-download-macos-linux.md but altered to be macos specific.

Copy link
Contributor Author

Copilot AI commented Aug 6, 2025

@copilot Instead of the changes you made, can you actually port this into the individual articles that reference the include file, then remove the include file? Adjust the include file's content to be...

I'll implement this cleaner approach by removing the include file and porting platform-specific content directly into each article. This will eliminate the need for a shared include that tries to handle both platforms.

Copilot AI changed the title Add macOS-specific checksum validation instructions for .NET installation Replace shared include file with platform-specific checksum validation instructions Aug 6, 2025
@adegeo adegeo marked this pull request as ready for review August 6, 2025 21:20
@adegeo adegeo requested a review from a team as a code owner August 6, 2025 21:20
@adegeo adegeo enabled auto-merge (squash) August 6, 2025 21:20
@BillWagner
Copy link
Member

The build warning is unrelated. Closing and reopening for a fresh build

@BillWagner BillWagner closed this Aug 7, 2025
auto-merge was automatically disabled August 7, 2025 14:04

Pull request was closed

@BillWagner BillWagner reopened this Aug 7, 2025
Copy link
Member

@BillWagner BillWagner left a comment

Choose a reason for hiding this comment

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

@copilot you need to fix the broken links to the images.

Copy link
Contributor Author

Copilot AI commented Aug 7, 2025

@copilot you need to fix the broken links to the images.

Fixed the broken image links by correcting the paths from ../media/install-sdk/ to media/install-sdk/ in both linux-scripted-manual.md and macos.md. Commit fbab0fb.

Copilot AI requested a review from BillWagner August 7, 2025 14:20
@adegeo adegeo enabled auto-merge (squash) August 7, 2025 16:16
@adegeo
Copy link
Contributor

adegeo commented Aug 7, 2025

@BillWagner

Copy link
Member

@BillWagner BillWagner left a comment

Choose a reason for hiding this comment

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

This now LGTM.

@adegeo adegeo merged commit e981f35 into main Aug 7, 2025
10 checks passed
@adegeo adegeo deleted the copilot/fix-47112 branch August 7, 2025 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing macOS-specific checksum validation instructions

3 participants