docs: seed architecture/ capability docs from current code - #16
Merged
Conversation
Populate the truth home with the tool's current behavior so future changes have something to promote into: - eof-normalization.md — binary skip, none/append_lf/truncate action model, terminator handling (LF/CRLF/CR), in-place mutation - file-discovery.md — directory input, .gitignore rules, path resolution, binary open modes - cli.md — interface, "Fixing <file>" output, exit-code contract - README.md — link the three capability files Docs only, no code change. Co-Authored-By: Claude Opus 4.8 (1M context) <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.
Seeds the
architecture/truth home (introduced with the planning convention in #15) with the tool's current behavior, derived fromeof_fixer/main.py. Until now it held only aREADME.md, so the promotion rule had nothing to promote into.Capability docs
eof-normalization.md— the core: 1KB null-byte binary skip, thenone/append_lf/truncate(offset)action model, backward terminator walk with LF/CRLF/CR handling (style preserved, count normalized), and the Windows seek-before-write detail.file-discovery.md— directory-only input,GitIgnoreSpecrules (.git/.cache/.uv-cachebaseline + repo.gitignore), relative-path resolution,rbvsrb+open modes.cli.md— the interface,Fixing <file>stdout line, and the 0/1 exit-code contract that makes--checka CI gate.README.md— links the three capability files.Docs only, no code change.
Verification
just lint-ci→ ruff format/check, ty, andcheck-planningall pass.🤖 Generated with Claude Code