Skip to content

Lead the README with real life trigger examples - #35

Merged
alies-dev merged 2 commits into
mainfrom
alies-dev/readme
Nov 17, 2026
Merged

alies-dev merged 2 commits into
mainfrom
alies-dev/readme

Conversation

@alies-dev

@alies-dev alies-dev commented Nov 17, 2026 •

Copy link
Copy Markdown
Owner

Context

The README mixed the pitch with reference material: every flag, the config keys, date parsing rules, MSRV notes, and a CI snippet. A visitor had to read about 160 lines to learn what a tag looks like for their situation, and the first examples showed syntax rather than when you would write one.

Solution

The README now opens with one table of real situations, one row per trigger form (day, month, version, strict version, #123, issue URL, pull request URL), followed by the output those tags produce once they fire and one line on when to use the tool. Install and run are a few lines each, and everything else is linked from a short docs index.

Reference material moved to docs/ with no content dropped:

  • docs/dates.md: accepted and rejected date spellings, --warn, --today
  • docs/usage.md: all flags, output formats, exit codes
  • docs/configuration.md: todo-by.toml keys and precedence
  • docs/install.md: Homebrew, Cargo, binaries, the Rust 1.88 floor

The example outputs and the rejected date spellings were checked against the current binary.

Summary by CodeRabbit

  • Documentation
    • Reorganized the README into a concise overview and quick start, with examples, sample findings, common commands, and links to detailed guides.
    • Added guides covering installation options, CLI usage and exit codes, configuration and precedence, and date-trigger syntax and deadline warnings.
    • The README no longer includes detailed references for usage, triggers, CI workflows, scanning rules, or configuration.

- Open with one table of situations per trigger kind and the output they produce.
- Move reference material into docs/: dates, usage, configuration, install.
- Link every docs page from a short index at the end of the README.
@alies-dev alies-dev self-assigned this Nov 17, 2026
@coderabbitai

coderabbitai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Explain Change →

Walkthrough

The README now provides a shorter overview and links to separate guides. New guides document installation, commands and output, configuration, and date-trigger behavior.

Changes: todo-by documentation

Layer / File(s) Summary
README overview and installation
README.md, docs/install.md
The README presents trigger examples, sample findings, basic commands, and links to guides. The installation guide covers Homebrew, Cargo, and release binaries.
Command and configuration reference
docs/usage.md, docs/configuration.md
The usage guide covers commands, output formats, color controls, and exit codes. The configuration guide covers file discovery, supported keys, precedence, and --dump-config.
Date trigger reference
docs/dates.md
The guide describes date formats and validation, UTC overdue comparisons, warning options, and evaluation with --today.

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Merge Risk: Low · up to f21d7

The new README and guides are mostly accurate, but a few statements mislead. The PR trigger example can lead someone to drop a patch whose upstream fix never merged. The default command needs --online to check issues. The JSON format description omits its trailing summary line. Correct these small wording issues before or soon after merge.

Pre-merge checks: Passed 2

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "Lead the README with real life trigger examples" matches the main change. The README now opens with a table of trigger forms (day, month, version, strict version, #123, issue URL, pull requ…
Full details: Title check

Explanation

The title "Lead the README with real life trigger examples" matches the main change. The README now opens with a table of trigger forms (day, month, version, strict version, #123, issue URL, pull request URL) and their outputs, and the detailed reference material moved to docs pages. The title is short, specific, and states the primary change.

  • 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

- Pull request URLs and #123 for a PR already fire on merge; the README only showed issues.
@github-actions

Copy link
Copy Markdown
Contributor

🐰 Bencher Report

Projecttodo-by
Branchalies-dev/readme
Testbedubuntu-latest
Click to view all benchmark results
BenchmarkLatencyBenchmark Result
milliseconds (ms)
(Result Δ%)
Upper Boundary
milliseconds (ms)
(Limit %)
scan angular/angular📈 view plot
🚷 view threshold
135.12 ms
(+11.15%)Baseline: 121.57 ms
151.96 ms
(88.92%)
🐰 View full continuous benchmarking report in Bencher

@alies-dev alies-dev left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok

@alies-dev
alies-dev merged commit 0ca3d73 into main Nov 17, 2026
16 of 17 checks passed
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