Document subcommands module and fix architecture layout#4
Merged
Conversation
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
The architecture doc and module-level docs were written before the gix migration (PR #3) and the worktreeinclude-modes feature (PR #5). This re-checks them against the current code surface: - Decision #1: "Git CLI is authoritative" reframed as the GitBackend trait with two implementations (GitGix default, GitCli via WAFT_GIT_BACKEND=cli) backed by parity tests. - Decision #2: per-directory semantics are now one of three pluggable engines (claude-2026-04 default, git, wt-0.39); the per-directory discussion lives in its own section. - Repo layout adds config.rs, policy_filter.rs, worktreeinclude_engine.rs, the new test files, and the planning docs. - Command pipeline updated to 9 stages: policy resolution, select_candidates dispatch, post-selection policy filter. - README eligibility rule covers when_missing=all-ignored and the exclusion sets; the nested .worktreeinclude paragraph leads with the default (root-only) behavior. Co-Authored-By: Claude Opus 4.7 <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.
Summary
README.mdand CLI help strings match the code, and#![warn(missing_docs)]already enforces rustdoc coverage on public items.docs/architecture.md— the repo-layout diagram was missing the entiresrc/subcommands/directory, and the CLI-parsing pipeline step did not mention dispatch to subcommand handlers.//!doc comments tosrc/subcommands/{mod,copy,list,info,validate}.rs, which were the only source files without a file-level comment.Test plan
cargo buildcargo doc --no-deps(no warnings)waft --helpand each subcommand's--helpmatch the documented flags