docs: freshness fixes — dock badge TOML key, desktop_pins example#48
docs: freshness fixes — dock badge TOML key, desktop_pins example#48jaylfc wants to merge 2 commits into
Conversation
README's Configuration example and prose both wrote [dock.badges], but Config::dock_badges (src/config.rs) has no serde rename, so the real TOML key is dock_badges. Pasting the documented example into config.toml silently no-ops on any custom entries since [dock.badges] deserializes to nothing and the field falls back to its defaults — which happen to match the example's own claude/kilo values, masking the bug.
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
📝 WalkthroughWalkthroughThe README updates dock badge references to ChangesDocumentation update
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
Code Review Roast 🔥Verdict: No Issues Found | Recommendation: Merge Oh wait, this PR is actually clean. I need to sit down. I had my flamethrower warmed up and everything. 📊 Overall: Like finding a unicorn in production — I didn't think clean docs-only PRs existed anymore, but here we are. Files Reviewed (1 file)
Previous Review Summary (commit d9474b5)Current summary above is authoritative. Previous snapshots are kept for context only. Previous review (commit d9474b5)Status: No Issues Found | Recommendation: Merge Files Reviewed (1 file)
NotesThis is a docs-only change correcting the documented TOML key from The remaining Reviewed by nemotron-3-ultra-550b-a55b:free · Input: 71K · Output: 2K · Cached: 78.3K |
The Configuration section shows worked examples for [[apps]] and [[launcher]] but had none for desktop_pins, even though "What works today" documents pinned desktop shortcuts as a user-facing feature and Config::desktop_pins (src/config.rs) is an actively-used AppEntry list (not internal-only, unlike filemanager_view/desktop_positions). Added an example matching the real default_desktop_pins() entries (Files + Store via @files/@store) so users have a template to add their own.
What's stale and what's fixed
1. Wrong TOML table name for dock badge colors. README's Configuration example (and the "Dock app-grouping" bullet in "What works today") documented the per-app dock badge colors under a
[dock.badges]TOML table.Config::dock_badges(src/config.rs:117) has no#[serde(rename)], so the real TOML key isdock_badges, not a dotted[dock.badges]table. Verified by round-tripping both forms throughConfig::from_toml_str:[dock.badges]with custom entries deserializes to the defaults — any custom colors are silently dropped.[dock_badges]deserializes correctly, including custom entries.This bug survived prior docs-freshness passes because the example's own values (
claude = "orange",kilo = "yellow") are identical to the built-in defaults, masking the drop.2.
desktop_pinshad no documented TOML example. The Configuration section had worked examples for[[apps]]and[[launcher]]but none fordesktop_pins, even though "What works today" documents pinned desktop shortcuts as a user-facing feature andConfig::desktop_pins(src/config.rs:92-95) is an actively-usedAppEntrylist, not internal-only. Added an example matching the realdefault_desktop_pins()entries (Files + Store via@files/@store).Scope check
README.mdonly, no code/config/CI changes.docs/superpowers/{specs,plans}/2026-06-08-dock-grouping-rename*.mduntouched — those are historical design records per the repo's append-only convention, and they predate this drift.Repo activity (informational, no action taken)
Summary by CodeRabbit
dock_badgesTOML table name (instead of the dot-separated form) in the feature description and configuration example.[[desktop_pins]]section including default pinned entries for “Files” and “Store.”