Repository navigation
Order the README for human readers first, release 0.1.3 - #272
Merged
Merged
Conversation
The options table, the workspace id derivation and the ~600 lines of purge/prune/reconcile and disk accounting came before anything a reader types, and `## Examples` sat at line 1209 of 1620. The top half is now what someone needs on the way in: features, install, usage with the examples folded in beside the command shapes, workspace commands, the `dl --ls` global table, `aid`, the zellij pane, auth, tools, completion. A rule and one line mark where reference begins. Two structural moves beyond the reordering: - `## Global Commands` is split. Its table stays up top; the five deep subsections below it become `## Cleaning up: purge, prune, reconcile`, so `dl --ls` is no longer documented 600 lines down. - `## Workspace Sources` was a duplicate of the `## Examples` block. It is folded into the one canonical list, now `### Examples` under Usage. The header gains a short orientation paragraph and a two-row index. The badge wall keeps its place but loses the `## Continuous Integration Status` heading, so the first section is about the tool. No heading text was renamed: all 13 internal anchors still resolve, and nothing describing a command's behaviour changed.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Reviewer's GuideReorders and rewrites the README so that human-oriented onboarding (features, install, usage and examples, workspace/global commands, aid, zellij, auth, tools, completion) is at the top and all deep reference material is clearly separated, while bumping the devlaunch Rust workspace version to 0.1.3 and recording the release in the changelog. No command behavior or documented semantics change; only structure, examples, and orientation text are updated. Flow diagram for reordered README structure and reference boundaryflowchart TD
A[Header: orientation + badges + index] --> B[Features]
B --> C[Installation]
C --> D[Usage + Examples]
D --> E[Workspace_Commands]
E --> F[Global_Commands]
F --> G[aid]
G --> H[A_terminal_beside_the_agent]
H --> I[GitHub_authentication]
I --> J[Tools_in_every_workspace]
J --> K[Shell_completion]
K --> L[[Reference_boundary_rule]]
L --> M[Options]
M --> N[Workspace_IDs]
N --> O[Cleaning_up_purge_prune_reconcile]
O --> P[Shared_pixi_package_cache]
P --> Q[Worktree_backend]
Q --> R[Measuring_launch_time]
R --> S[Going_back_to_the_Python_build]
S --> T[Development]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #272 +/- ##
=======================================
Coverage 93.26% 93.26%
=======================================
Files 25 25
Lines 3771 3771
=======================================
Hits 3517 3517
Misses 254 254 🚀 New features to boost your workflow:
|
The README reorder was only half the job: `dl --help` had the same shape
it was complaining about. clap's default template renders `{all-args}`
— every one of the fourteen flags — between the usage line and the
`after_help` block, so the half of this CLI clap cannot describe from
its own arguments, the verbs and the examples somebody opened `--help`
to find, sat underneath the options nobody did.
`before_help` now carries the examples (first) and the workspace verbs,
and `help_template` is clap's own default with `{before-help}` moved
from the top to just above `{all-args}`. `Environment:` splits off into
`after_help`, where it stays last: it is read once and put in a shell
profile. Same flags, same verbs, same words, for both `-h` and
`--help` — a different order on screen.
`help_template` is a string clap resolves at render time, so a marker
that stops resolving is not a compile error, it renders literally and
takes its section with it. One test pins the section order, which is
what catches that.
`devlaunch-test-support`'s `versioned_with_the_workspace` asserts the crate's inherited version against a literal and cannot read it any other way, so it has to move with every release — the step 0.1.2's release commit documented after the 0.1.1 bump forgot it and left a developer's `cargo test --workspace` red. No CI job runs that crate, so nothing but running the suite catches it. Ran it; it was red; it is green. Also expands the changelog entry to cover the `--help` reorder.
Owner
Author
|
main released 0.2.0 and retired the `prune` verb while this sat, so three things needed hand-resolving rather than a hunk pick: - **Version.** 0.1.3 here vs 0.2.0 released on main, so this becomes 0.2.1: `rust/Cargo.toml`, the five workspace crates in `Cargo.lock`, and `devlaunch-test-support`'s version tripwire. - **The README conflicted structurally, not textually.** This branch moved whole sections; main edited four places in the old positions, so git matched moved text against in-place edits and produced hunks whose two sides were unrelated prose. Resolved by taking this branch's ordering and applying main's four changes at their new anchors: the `rm, prune` -> `rm` table row, the `--stop`/`--rm` suffix and retired `prune` sections (under `## Workspace Commands`, where they belong), the CI-uid paragraphs in the pixi cache section, and `### The prebuilt dev container image`. A sorted line diff against main confirms nothing of main's was dropped. - **`--help`'s new prose moved into `GRAMMAR`.** main added the suffix-flag and retired-`prune` notes to the epilogue; they are grammar, so they belong above the options table with the verbs, not below with the environment. One wording fix fell out of the move: main's "it collided with --prune above" pointed at an options table that is now below, so it reads "the --prune flag below". Verified: cargo test --workspace 1448 pass / 0 fail, clippy --locked --all-targets -D warnings clean, cargo fmt --check clean, prek clean, `dl --help` and `dl --version` (0.2.1) read by eye.
blooop
added a commit
that referenced
this pull request
Aug 20, 2026
0.2.1 went out from main while this branch was open (#272, the --help and README reordering): tag v0.2.1 is on main's tip and the GitHub release exists. So the version bump here had to move, and it is not a cosmetic renumber -- Auto-publish skips a version it finds already tagged, so merging this branch claiming 0.2.1 would have published nothing at all and said so only in a log nobody reads. Cargo.toml, Cargo.lock and devlaunch-test-support's version pin go to 0.2.2, and the changelog keeps both sections: their 0.2.1 as shipped, this branch's notes under 0.2.2 above it. The README conflict is main's reordering rather than a disagreement. That commit moved the whole reference half of the document, including `## The shared pixi package cache`, and left a short intro where it used to be -- so this takes main's text at that position outright and re-places `### Where the tools themselves land` where its neighbours went, still between the shared-cache section and the recreate note. Same for the earlier conflict in this branch: main's shared-cache uid paragraph and this branch's subsection were both insertions at one point, and both are kept.
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
derivation, and the ~600 lines of purge/prune/reconcile and disk accounting came before
anything a reader types, and
## Examplessat at line 1209 of 1620. The top half is nowfeatures → install → usage (with the examples folded in beside the command shapes) →
workspace commands → the
dl --lsglobal table →aid→ zellij pane → auth → tools →completion. A rule and one line mark where reference begins.
## Global Commandsis split. Its table stays in the human half; the five deepsubsections beneath it become
## Cleaning up: purge, prune, reconcile, sodl --lsis nolonger documented 600 lines down.
## Workspace Sourceswas a duplicate of the## Examplescode block — folded into onecanonical list, now
### Examplesunder Usage.place but loses the
## Continuous Integration Statusheading, so the first section is aboutthe tool.
rust/Cargo.toml(the single source) withrust/Cargo.lockand aCHANGELOG.mdentry to match.No heading text was renamed and nothing describing a command's behaviour changed.
Test plan
prek run --from-ref origin/main --to-ref HEAD— all hooks pass (codespell, end-of-file,mixed-line-ending, check-toml).
](#anchor)links resolve against the new heading set (checkedmechanically, not by eye).
Workspace Sources block, the three retitled/absorbed headings, and reworded example
comments — the reorder is otherwise byte-preserving.
packagingjob asserts the wheel version equalsrust/Cargo.toml's and builds--locked, which is what checks the lockfile edit below.Review notes
rust/Cargo.lockwas edited by hand. No cargo is available in this devcontainer, so thefive workspace crates'
versionlines (aid,dl,devlaunch-core,devlaunch-runner,devlaunch-test-support) were bumped directly — deliberately leaving the two third-partypackages that also sit at
0.1.2(dirs-sys-next,iana-time-zone-haiku) alone. The diffis 5 lines, the same shape as Release 0.1.1 #269's and Release 0.1.2 #271's.
--lockedin CI is the check.pixi.lockwas already modified in the working tree before this work and is unrelated,so it is deliberately not in this PR.
prefix.dev via
Auto-publish. That was asked for explicitly; say the word and I will dropthe release commit and leave the entry under
[Unreleased].## Measuring launch timestill shows$ dl --version→dl 0.1.0as sample output. It wasalready stale before this PR and is illustrative, so it is left alone rather than churned.
🤖 Generated with Claude Code
Summary by Sourcery
Improve the reader-facing documentation and CLI help flow, then release the changes as version 0.2.1.
Enhancements:
Build:
Documentation:
Tests: