docs: fix readme code sample, docker tag, and navigation - #240
Conversation
- add a Table of Contents and a Quick Start section near the top - make the Git Workflow section consistently target the develop branch - add language hints to the remaining unfenced/untagged code blocks - fix grammar, typos, and a sentence fragment throughout Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HsvnEPt2jDmCwrM5Rdq8tP
|
CI red on
This change only edits The AppVeyor build logs are not publicly readable (the API returns 403), so I could not confirm the underlying error. Worth noting that the base branches report under the AppVeyor project The GitHub Actions Generated by Claude Code |
|
Follow-up: PR #237 (
So the Both AppVeyor contexts are therefore red for reasons that predate this branch, on a commit that changes only Everything else on Generated by Claude Code |
Documentation-only cleanup of
README.md. No source code was touched.Changes
DownloadBuilderexample.vX.Y.Zin some places anddevelopin others. It now saysdevelopeverywhere (steps 5 and 10, and the closing paragraph)..downloadfile-layout diagram astext, and converted the two indented install snippets into fencedtext/bashblocks. Every fenced block in the file now carries a language.'.downlaod'typo, a sentence fragment in the Content-Length section, "chunker downloads" → "chunk downloads", "please giving it a ⭐" → "please give it a ⭐", several "default values is" → "the default value is", and a few mid-sentence capitalizations in code comments. Meaning and tone are unchanged.Items that were already correct
Two requested fixes turned out to be already fixed on
develop, so this PR does not change them:Authorization = new AuthenticationHeaderValue("Bearer", …)line in the Complex Configuration sample has no stray semicolon.mcr.microsoft.com/dotnet/sdk:10.0.Noted, not changed
The Building a Native AOT Version section still documents
.NET 8.0 SDKand-f net8.0publish commands. That is pre-existing content outside the scope of this cleanup, but it may be worth refreshing tonet10.0in a follow-up.Generated by Claude Code