docs: resolve 11 documentation inconsistencies from audit report#307
docs: resolve 11 documentation inconsistencies from audit report#307nextlevelshit merged 1 commit intomainfrom
Conversation
Implement non_empty_file contract validator (DOC-002), add missing CLI command docs for compose/doctor/suggest (DOC-001), fix global flags and --model documentation (DOC-003, DOC-004), remove duplicate chat entry (DOC-010), correct architecture doc workspace path/OpenCode status/contract types (DOC-005, DOC-006, DOC-007), align max_retries defaults (DOC-009), clarify CLAUDE_CODE_MODEL usage (DOC-011), and update quick-start output (DOC-012). DOC-008 was already resolved by prior commit f5987f2.
Code Review (Wave Pipeline)Verdict: REQUEST_CHANGES The Critical Issues1. The exhaustive factory dispatch test covers Add to the table: {"non_empty_file", ContractConfig{Type: "non_empty_file"}, false, "*contract.nonEmptyFileValidator"},While you're there, consider adding the also-missing 2. Validator silently passes for directories —
3. Behavioral change needs documentation — Previously Suggested ImprovementsPath traversal outside workspace boundary — The validator resolves This is a systemic gap — all existing validators have the identical pattern. The project's Error messages expose full filesystem paths — Error messages include the resolved absolute path (e.g., File naming convention — The package uses either underscore-separated ( Add missing test cases — The test suite covers happy paths well but is missing: directory-as-source, path traversal inputs ( Positive Observations
Generated by Wave gh-pr-review pipeline |
docs: resolve 11 documentation inconsistencies from audit report
Summary
wave doctor,wave forge, andwave suggestnon_empty_filecontract validator in Go with comprehensive test coverage--modelflag, removed duplicatewave chatentryCloses #303
Changes
--json/--quiet/--no-color(DOC-003),--modelflag for run/do/meta (DOC-004), removed duplicatewave chatentry (DOC-010)non_empty_filecontract validator implementation (DOC-002)non_empty_filein contract type registrymax_retriesdefault documentation (DOC-009)non_empty_filetype documentation, alignedmax_retriesdefault (DOC-002, DOC-009)CLAUDE_CODE_MODELrequiresenv_passthrough(DOC-011)wave initoutput example and sample config (DOC-012)Test Plan
go test ./internal/contract/...validates the newnon_empty_filecontract validatorgo test -race ./...passes all tests