docs: portability, professional pass and Windows support - #12
Merged
Merged
Conversation
The script now reconfigures stdout to UTF-8 in main(), so the report is byte-identical on Windows legacy console codepages (cp437/cp1252) instead of crashing with UnicodeEncodeError mid-report (the em-dash in the --source span message). Regression test fails without the fix; a CI portability job runs the full self-check with and without -O on windows-latest and macos-latest. SKILL.md: description cut 640 -> 483 characters (released OpenAI Codex builds hard-fail above 500); script paths anchored to the directory containing SKILL.md so symlinked installs work; py -3 documented; the --source paragraph and the rules-audit sentence split into readable lists; the dangling "P7's I14 and I15" reference replaced with a concrete example; work package glossed once. README: example ships as committed files (examples/example.md and the byte-reproducible example-output.md); the finding classes counted as four plus the unstated residue; N-squared/DSM glossed; Windows noted; test counts updated to 84. RUNBOOK defers section-9 detail to SKILL.md. SECURITY names the supported version without first-release trivia; the bug-report version placeholder is no longer a hardcoded tag. Changelog records everything under Unreleased and dates 0.2.1 correctly as 2026-09-26. Validated: 84 self-tests green with and without -O; skills-ref validate (clean pinned 69ef37e9); every http(s) link in tracked .md files returns 200; every relative link resolves; example output reproduced byte-for-byte from examples/example.md. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Merged
macblackstuff
added a commit
that referenced
this pull request
Sep 29, 2026
Cut from Unreleased: Windows UTF-8 portability + regression test, CI portability job (windows/macos), Codex-safe 483-char description, path anchoring to the SKILL.md directory, committed byte-reproducible example, doc fixes from the audit. All 8 CI checks green on the source PR (#12); this release PR re-runs them. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
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.
Professional pass over every public file, from the compat/SEO/doc audit.
Windows portability (real bug, reproduced): on legacy Windows console codepages (cp437, ASCII pipes) the script crashed with
UnicodeEncodeErroron the em-dash in the--sourcespan message.main()now reconfigures stdout to UTF-8. New regression test runs the script under a cp437-strict stdout and fails without the fix (verified RED without it, GREEN with). New CIportabilityjob: full self-check with and without-Oonwindows-latest+macos-latest.Codex compatibility: SKILL.md description cut 640 → 483 characters (released Codex builds hard-fail above 500).
Skill paths: "run scripts from the directory containing this SKILL.md" — correct under symlinked installs (Codex/OpenCode) and any working directory.
py -3documented for Windows.Docs: example now ships as committed files (
examples/example.md,examples/example-output.md— reproduced byte-for-byte in CI-verified local run); four finding classes counted correctly; N²/DSM glossed in plain English; section-9 and --source run-on sentences broken into lists; dangling "P7's I14 and I15" replaced with a concrete example; SECURITY names the supported version; issue-form placeholder un-hardcoded; 0.2.1 changelog date corrected to 2026-09-26.Validation: 84 tests green (plain +
-O); skills-ref validate passes (pinned 69ef37e9); all 10 http(s) links return 200; all relative links resolve.🤖 Generated with Claude Code