Repository navigation
docs: consolidate to three files — active tracker, publishing runbook, merged ratatui reference - #19
Merged
Merged
Conversation
…ompleted plan The duct-runner full-fledged plan was three months stale (last audited 2026-06-26 while runner code moved through 2026-10-02): it listed already- fixed gaps as open and never recorded work that landed after the audit. - Add docs/runner-remaining-work.md as the single tracker for unimplemented work, organized by work area instead of phases: parity closeout, crate documentation, command-intent rulings, Duct stdin error mapping, diagnostics hardening, and items deferred by decision. Each area carries acceptance criteria, and the serde field-addition pattern plus the Phase 6/7 decision rules are carried over. - Archive the old plan to docs/completed/ (repo convention for finished plans) with a superseded banner; statuses were first reconciled against the code on 2026-10-09 (Phases 1-5 implemented, 7 closed by decision, 8 substantially done; 227 tests + 9 doctests green, fmt clean). - Point the duct_runner.rs process-tree comment at the new tracker.
…ratch Cut docs/ from 15 files to 3: the active tracker, the publishing runbook, and one merged ratatui reference. - Delete docs/completed/ entirely (10 finished plans, incl. the archived duct-runner plan) — git history preserves them and the audit trail. - Merge the two ratatui best-practices notes into a single docs/ratatui-best-practices.md (Part I focus/keyboard/vim/layout, Part II state/lifecycle/async, one unioned Dependencies section). - Delete docs/tools.md (scratch feature-list notes). - Keep docs/publishing.md (referenced by README and publish workflow) and docs/runner-remaining-work.md (active tracker); repoint the tracker's archive reference to git history.
hmziqagent
changed the title
hmziqrs
approved these changes
Oct 10, 2026
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.
What
docs/ had 15 markdown files (~390 KB): a three-months-stale phases plan, a 10-file finished-plan archive, two overlapping ratatui notes, a scratch tools note, and a publishing runbook. This PR cuts it to 3 files and deletes the rest.
Final state
Changes
run_checkedredaction, stderr secret leaks,CommandTimeoutDebug leaks, Tokiooutput_mode— and missed fields landed after its June audit:stdin_null,env_precedence,path_resolution,argv_policy,output_cap). Extracted the genuinely-remaining work intodocs/runner-remaining-work.mdwith acceptance criteria per area.docs/completed/entirely (10 finished plans). Git history preserves them and the audit trail.docs/tools.mdscratch notes.docs/publishing.md(actively maintained, referenced by README and CI).duct_runner.rs(process-tree policy note → new tracker).Deleted content is all recoverable from git history; nothing untracked was touched.
Verification
cargo test -p toride-runner --features 'duct-runner tokio-runner serde stream fake'→ 227 unit tests + 9 doctests pass; 0 failurescargo fmt/cargo checkclean; clippy shows only 2 pre-existing pedantic test-style warningsduct_runner.rscomment was updated)