Skip to content

Fix stale claims in README and the csproj comments - #75

Merged
wormeyman merged 1 commit into
mainfrom
chore/audit-readme-and-csproj-comments
Aug 10, 2026
Merged

Fix stale claims in README and the csproj comments#75
wormeyman merged 1 commit into
mainfrom
chore/audit-readme-and-csproj-comments

Conversation

@wormeyman

Copy link
Copy Markdown
Collaborator

Continues #74's sweep into the two places it did not cover. Every claim below was checked against the code or the live site, not eyeballed.

Stale (fixed)

Where Claim Reality
README:17 tool is at factoriotools-5jg.pages.dev 301-redirects to oilfieldplanner.factorygamefan.com
README:41 "I captured 57 test blueprints" 58 when written (2023), 61 today
WebApp.csproj "the net7-targeted Swashbuckle CLI" highest TFM is net8.0 since #63 (6.5.0 -> 6.9.0)
CLAUDE.md:133 manifest at .config/dotnet-tools.json src/WebApp/.config/dotnet-tools.json

Notes on two of these:

The blueprint count is Joel's first-person prose from 2023, and this fork's main is the head of upstream PR #10, so edits land there. Rather than revise a historical statement to a number that goes stale on the next blueprint added, it now reads "a set of test blueprints" and links small-list.txt for the live count.

The CLI target framework matters beyond pedantry: the roll-forward is still needed (net8 -> net10 is still major), so the note now says so explicitly and warns against assuming a future CLI bump makes DOTNET_ROLL_FORWARD removable without checking the package's tools/ TFMs. 6.5.0 genuinely was net7.0 - the comment was right when written.

Verified correct - no change

Listing these so this reads as an audit rather than a spot-check:

  • "up to 16 different planning routines" is exactly right: 4 default pipe strategies x optimized/unoptimized x 2 default beacon strategies. (The scoreboard shows 37 distinct winning plans, which is a different quantity - that run enables all strategies plus beacons-off.)
  • All three screenshots exist; the Score file does have a table at the bottom; /oil-field is a real route in main.ts and serves the SPA.
  • ImageSharp pin comment holds on every point - 3.1.12/2.1.7 pinned, the ItemGroup gated on EnableVisualizer, the Debug-only default genuinely surviving Directory.Build.props (its EnableVisualizer=false is scoped to the UseLuaSettings group only), and Visualizer.cs behind #if ENABLE_VISUALIZER.
  • OpenApi hold comment: both named schema filters really do use the APIs it says Microsoft.OpenApi 2.x removes - OpenApiSchema.Nullable and the Microsoft.OpenApi.Any types.
  • Dockerfile really does publish self-contained linux-musl-x64 with GenerateSwagger=false; tool manifest really is 6.9.0, matching renovate.json5.
  • BlazorWebApp.csproj's only comment is commented-out MSBuild properties - dead config, not a claim.

One thing found but not fixed

/oil-field returns HTTP 404 while rendering correctly - Cloudflare Pages serves the build's 404.html (a copy of index.html) for SPA routes. Harmless in a browser, but link checkers and crawlers see a 404 on the URL the README advertises. Pre-existing and unrelated to this PR, so raising it rather than changing deploy behaviour here.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Wgci7Q7mw8PjJRHAaS78X2

Continues the sweep from #74 into the two places it did not cover. Everything
below was checked against the code or the live site rather than eyeballed.

README pointed at https://factoriotools-5jg.pages.dev/oil-field, which now
301-redirects to oilfieldplanner.factorygamefan.com. That line is fork-owned
(17d3e68), so it now names the canonical host directly and readers skip a hop.

README said "I captured 57 test blueprints". The corpus held 58 when that was
written in 2023 and holds 61 now. Rather than revise a first-person historical
statement to a number that will go stale again, it now says "a set of test
blueprints" and points at small-list.txt for the current count.

WebApp.csproj described the Swashbuckle CLI as net7-targeted. Its highest
shipped target framework has been net8.0 since #63 moved the CLI 6.5.0 -> 6.9.0
- 6.5.0 really was net7.0. DOTNET_ROLL_FORWARD=Major is still required either
way, since net8 to net10 is still a major roll-forward, so the note now says
that and warns against assuming a future CLI bump makes it removable.

CLAUDE.md located the tool manifest at ".config/dotnet-tools.json", which reads
as the repo root and is not there. It is src/WebApp/.config/dotnet-tools.json.
renovate.json5 already had the full path; the two now agree.

Verified correct and deliberately left alone: README's "up to 16 different
planning routines" is exactly right for default settings (4 pipe strategies x
optimized/unoptimized x 2 beacon strategies), the three screenshots exist, the
Score file does have a table at the bottom, /oil-field is a real route, the
ImageSharp pin comment holds on every point including the Debug-only default
surviving Directory.Build.props, and the OpenApi hold comment's two named
schema filters really do use the APIs it says 2.x removes.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Wgci7Q7mw8PjJRHAaS78X2
@wormeyman
wormeyman merged commit 503bfbe into main Aug 10, 2026
8 checks passed
@wormeyman
wormeyman deleted the chore/audit-readme-and-csproj-comments branch August 10, 2026 23:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant