Skip to content

docs: show the tier names the CLI prints in the README images - #236

Merged
FeathBow merged 3 commits into
mainfrom
docs/refresh-the-readme-images
Nov 1, 2026
Merged

FeathBow merged 3 commits into
mainfrom
docs/refresh-the-readme-images

Conversation

@FeathBow

@FeathBow FeathBow commented Oct 27, 2026 •

Copy link
Copy Markdown
Owner

Summary

#166 renamed the first tier from "Ready to clean" to "Eligible to clean", but the README's three images were captured before it and still show the old name, as do their alt text and the comment on degu clean in the lifecycle block. The images are rendered again from a real run of main at d1db13a, with the renderer #103 describes, on Linux and at the full fixture size, so the totals they show are unchanged. Besides the tier name, they now show what the scan and the review changed since: the line under the eligible heading, the reworded Not managed note, the numbered panels, the wider classification column and the t trash key.

In the list of what a preview reports before execution, "inventory ceilings" becomes "inventory bounds", since #227 and #228 retired the directory ceilings. The two checks added since, a source name too long for the trash (#232) and the room left in the seal WAL (#222, #223, #224), get a sentence of their own rather than joining that list: the preview blocks both, but staging measures both again against what the trash holds then, so it can still refuse an item the preview admitted. The user guide now says why for the name: the preview reads no trash and checks the name behind 0001-, while a clean checks it behind the sequence its reservation takes, which has five digits once the trash holds an entry numbered 9999.

Rendering note. The review reads the account's readiness before it opens, so the account that renders it has to be set up with degu init first. Without that, the header reads "Cleanup unavailable" instead of the plan total.

Validation

Passed locally on this branch:

cargo fmt --all --check
cargo clippy --workspace --all-targets --locked -- -D warnings
cargo test -p degu --test readme

The README contract tests are at 6 passed / 0 failed. I compared the visible text of each new image with the committed one; the differences are the ones listed above, and the header still reads "In the plan: 2 locations · 9.33 GiB".

@coderabbitai

coderabbitai Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 235eaf46-275c-47cc-a9e4-dd7d80061f93
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@FeathBow
FeathBow merged commit 2beccef into main Nov 1, 2026
11 checks passed
@FeathBow
FeathBow deleted the docs/refresh-the-readme-images branch November 1, 2026 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant