docs(audit): correct stale refs in CONTRIBUTING + workflow docs#217
Merged
Conversation
Accuracy audit per #139 — verify CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md, and docs/*.md against the current repo state. Findings + fixes: - CONTRIBUTING.md "The 7 Analyzers" — Directory.Build.props now wires 8 analyzers (PublicApiAnalyzer was added in 0.3.2 / A1). Renamed the section and added the missing entry. - docs/WORKFLOW_SECURITY.md — example pinned actions/checkout@v6; the workflow uses @v7 now. Bumped the reference. - docs/RELEASE-WORKFLOW-SETUP.md — the "Expected Workflow Behavior" enumeration and the Workflow Architecture ASCII diagram described only 3 jobs (validate-release → pack-and-validate → publish-nuget). release.yaml actually runs 6: added verify-docs-build (D8, 0.3.2), trigger-docs (workflow_call → docfx.yaml), and update-release- artifacts to both the enumeration and the diagram. Files verified accurate as-is, no changes needed: - SECURITY.md (24 lines, generic Security tab procedure) - CODE_OF_CONDUCT.md (Contributor Covenant 2.0, no repo-specific facts) - CHANGELOG.md (latest entry matches the v0.3.2 ship state) - docs/README-FORMATTING.md (refs .editorconfig as source of truth; current .editorconfig matches the rules described) - docs/DOCFX-VERSION-PICKER.md (describes the canonical version-picker wiring; see separate task for the docfx.json `_appFooter` drift) Closes #139
This was referenced Jun 28, 2026
Chris-Wolfgang
added a commit
that referenced
this pull request
Jun 28, 2026
Tier-1 maintenance round — docs accuracy, code-review polish, and a single behaviour fix on the docs-site version picker. No public API or runtime behaviour change in Wolfgang.TryPattern itself, so a PATCH bump per SemVer. Contents this release: - Fix: docfx.json _appFooter version-picker bootstrap restored (caught during docs accuracy audit; fanned out to the 12 other affected Wolfgang.* repos in parallel) — PR #224 - Docs: README structure standardized to canonical fleet layout (License + Documentation hoisted; Code Quality section added) — PR #216, closes #135 #138 - Docs: accuracy audit fixes for CONTRIBUTING.md analyzer count, WORKFLOW_SECURITY.md actions/checkout version, RELEASE-WORKFLOW- SETUP.md jobs enumeration — PR #217, closes #139 - Chore: AI code-review pass — Result/Try XML doc improvements, test naming convention compliance, csproj hygiene, F# example module-name copy-paste fix; 5 larger findings filed as separate sub-issues — PR #223, closes #128 - Maintenance: verified and closed #127 (branch cleanup), #146 (PublicApiAnalyzer baseline), #152 (benchmarks TWAE) — all three already implemented at framework level by the canonical sync; this round was verification only.
7 tasks
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
Accuracy audit per #139 of CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md, CHANGELOG.md, and docs/*.md. Three stale references found and fixed.
Stacked on #216 (README PR). Base auto-promotes to vNext when #216 merges.
Drift fixed
CONTRIBUTING.mddocs/WORKFLOW_SECURITY.mdactions/checkout@v6example@v7(matches actualpr.yaml)docs/RELEASE-WORKFLOW-SETUP.mdVerified accurate as-is — no changes
SECURITY.md— generic Security-tab procedure, no project-specific factsCODE_OF_CONDUCT.md— Contributor Covenant 2.0 verbatimCHANGELOG.md— latest entry matches v0.3.2 ship state (Unreleased empty; v0.3.3 entries will be added when the vNext PR merges)docs/README-FORMATTING.md— refers to.editorconfigas source of truth; current.editorconfigmatchesdocs/DOCFX-VERSION-PICKER.md— accurately describes the canonical version-picker wiringOut-of-scope follow-up
Audit also surfaced a real bug separate from doc accuracy: Try-Pattern's
docfx_project/docfx.jsonhas `"_appFooter": "Made with DocFX"` (no script). The canonical repo-template version inlines the version-picker bootstrap into_appFooter. Result: the deployed docs site at https://chris-wolfgang.github.io/Try-Pattern/versions/latest/ likely has no version-picker UI. This is a behavior fix, not a docs fix — split perfeedback_pr_scope_by_concern.Test plan
pr.yaml/release.yaml/Directory.Build.propsCloses #139
Part of the v0.3.3 Tier-1 maintenance pilot (vNext: #121).