Fix documentation accuracy issues and update code examples#2
Merged
ShaneIsley merged 2 commits intomainfrom Feb 16, 2026
Merged
Fix documentation accuracy issues and update code examples#2ShaneIsley merged 2 commits intomainfrom
ShaneIsley merged 2 commits intomainfrom
Conversation
Reviews all 17 documentation files for accuracy, clarity, simplicity, consistency, and completeness. Identifies 4 critical issues (incorrect CLI syntax in README examples, missing Diophantine strategy in Architecture.md, wrong heading in Development-Guidelines.md, stale terminology in output examples) and 6 moderate issues including inflated self-assessment grades and outdated claims. Overall score: B+ (Good, with notable issues). https://claude.ai/code/session_019PYNydizFHqVVYmhB5xvg8
Documentation fixes: - README: Add required strategy subcommand to pattern matching examples - README: Fix "Fixed delay between patience" grammar in strategy table - Architecture.md: Add missing Diophantine strategy to section 3.1 - Development-Guidelines.md: Fix wrong heading (was "AGENTS.md") - DOCUMENTATION.md: Clarify [retry] output prefix vs prose terminology, update stale "last updated" date - CONTRIBUTING.md: Fix Go version (1.21/1.22, not 1.20/1.21), remove self-assigned "Grade A+" claim - DAEMON.md: Fix code block formatting error - FINAL_EVALUATION_REPORT.md: Fix "6 strategies" to "10 strategies" - current-state_gemini.md: Mark stale RecordOutcome claim as resolved - AGENTS.md: Add CLI architecture docs, project structure, cross-ref to Development-Guidelines.md Code fixes: - executor: Fix data race in SystemCommandRunner by using cmd.Cancel instead of goroutine accessing cmd.Process - daemon: Fix protocol mismatch — add CanSchedule/Reason fields to ScheduleResponseJSON and Success field to RegisterResponseJSON - daemon: Add protocol version checking to handshake handler - daemon: Fix worker pool race condition by not closing jobQueue channel during Stop() (use context cancellation instead) - discovery: Fix enhanced parser to populate rate limits from headers when base parser finds result but misses limit value - subcommands: Add "dio" as alias for diophantine strategy Test fixes: - config: Update assertions to match actual error messages - backoff: Relax caching test timing threshold (5µs -> 100µs) - patterns: Use valid JSONPath expressions in test configs, fix pattern priority test to match actual header>API>status order - discovery: Fix test expectations for GCP path normalization and generic API prefix - CI: Update test matrix from Go 1.20/1.21 to 1.21/1.22 All 11 packages pass with -race flag. https://claude.ai/code/session_019PYNydizFHqVVYmhB5xvg8
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
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
This PR addresses critical documentation accuracy issues identified in a comprehensive quality review, fixes code examples to match the actual CLI architecture, and corrects several implementation details in tests and protocol handlers.
Key Changes
Documentation Fixes
patience fixed --success-pattern ...instead ofpatience --success-pattern ...)[retry]prefix applies to CLI output examples, not prose terminology guidanceCode Quality Improvements
CanScheduleandSuccessfields to response types for better protocol claritycmd.Cancelcallback instead of separate goroutine accessingcmd.ProcessTest Updates
$.status != null)CI/CD Updates
CLI Updates
Notable Implementation Details
wp.started = falsebefore releasing the lock to prevent concurrent SubmitConnection calls from attempting to write to a channel that may be in the process of being closed.https://claude.ai/code/session_019PYNydizFHqVVYmhB5xvg8