docs: audit other markdown — code samples + PackageReference (#139)#214
Merged
Conversation
…started version (#139) Markdown audit per the tier-1 issue. Most files are accurate against current repo state (CONTRIBUTING, SECURITY, CODE_OF_CONDUCT, PR template, README-FORMATTING, DOCFX-VERSION-PICKER, WORKFLOW_SECURITY, docfx_project index/introduction/setup, RELEASE-WORKFLOW-SETUP) — verified end-to-end. Two real bugs found and fixed: - .github/copilot-instructions.md — stray spaces in 7 code samples (`Try. Run`, `string. IsNullOrWhiteSpace`, `result. Succeeded`, etc.) meant the snippets would not compile if copy-pasted; also the RunAsync<T> XML-doc example was missing the CancellationToken parameter that the real API takes. - docfx_project/docs/getting-started.md — PackageReference example showed v0.3.0; bumped to v0.3.1 (latest published tag). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Chris-Wolfgang
force-pushed
the
docs/135-138-readme
branch
from
f18e181 to
0c5164a
Compare
Chris-Wolfgang
force-pushed
the
docs/139-other-md
branch
from
a98c5d9 to
e15c015
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Markdown audit for accuracy across CONTRIBUTING / SECURITY / CODE_OF_CONDUCT, PR template,
.github/copilot-instructions.md,docfx_project/**/*.md, anddocs/**/*.md. Most files passed end-to-end against current repo state. Two real bugs fixed:.github/copilot-instructions.md— stray spaces in 7 code samples (Try. Run,string. IsNullOrWhiteSpace,result. Succeeded,result. ErrorMessage,Result<TResponse>. Failure,Result. Failure,Result. Success) meant the snippets would not compile if copy-pasted. TheRunAsync<T>XML-doc example was also missing theCancellationTokenparameter that the real API takes.docfx_project/docs/getting-started.md—PackageReferenceexample pinned to0.3.0; bumped to0.3.1(latest published tag).Files verified accurate (no change): CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md, PR template, README-FORMATTING.md, DOCFX-VERSION-PICKER.md, WORKFLOW_SECURITY.md, RELEASE-WORKFLOW-SETUP.md, docfx_project/index.md, docfx_project/api/index.md, docfx_project/docs/{index,introduction,setup}.md.
Stacking
Based on #213 → #212 → #211 → vNext.
Closes #139.