Skip to content

docs: freshness fixes — dock badge TOML key, desktop_pins example#48

Open
jaylfc wants to merge 2 commits into
mainfrom
docs/auto-freshness-20260720
Open

docs: freshness fixes — dock badge TOML key, desktop_pins example#48
jaylfc wants to merge 2 commits into
mainfrom
docs/auto-freshness-20260720

Conversation

@jaylfc

@jaylfc jaylfc commented Jul 20, 2026

Copy link
Copy Markdown
Owner

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 is dock_badges, not a dotted [dock.badges] table. Verified by round-tripping both forms through Config::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_pins had no documented TOML example. The Configuration section had worked examples for [[apps]] and [[launcher]] but 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:92-95) is an actively-used AppEntry list, not internal-only. Added an example matching the real default_desktop_pins() entries (Files + Store via @files/@store).

Scope check

  • Docs-only — README.md only, no code/config/CI changes.
  • Left docs/superpowers/{specs,plans}/2026-06-08-dock-grouping-rename*.md untouched — 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

  • Documentation
    • Updated the README to use the correct dock_badges TOML table name (instead of the dot-separated form) in the feature description and configuration example.
    • Expanded the configuration example with a new [[desktop_pins]] section including default pinned entries for “Files” and “Store.”

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-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The README updates dock badge references to [dock_badges] and adds default [[desktop_pins]] examples for “Files” and “Store”.

Changes

Documentation update

Layer / File(s) Summary
Update TOML configuration documentation
README.md
The feature description and configuration example now use [dock_badges] and include example desktop pins for “Files” and “Store”.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: claude

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the README docs update for the dock badge TOML key and desktop_pins example.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/auto-freshness-20260720

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

Comment @coderabbitai help to get the list of available commands.

@gitar-bot

gitar-bot Bot commented Jul 20, 2026

Copy link
Copy Markdown

Gitar is working

Gitar

@kilo-code-bot

kilo-code-bot Bot commented Jul 20, 2026

Copy link
Copy Markdown

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)
  • README.md - 2 commits, both verified correct against src/config.rs
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)
  • README.md - 2 lines changed (both verified correct)

Notes

This is a docs-only change correcting the documented TOML key from [dock.badges] to [dock_badges]. The fix was verified against src/config.rs:117, which defines pub dock_badges: BTreeMap<...> with no #[serde(rename)] — confirming dock_badges is the real deserialization key. The PR's root-cause analysis is accurate: the previous [dock.badges] table silently deserialized to defaults, masking the bug because the example values matched the built-in defaults.

The remaining [dock.badges] references in docs/superpowers/{specs,plans}/ are historical append-only design records and are correctly left unchanged, consistent with the repo's documentation convention.


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.
@jaylfc jaylfc changed the title docs: fix wrong TOML table name for dock badge colors docs: freshness fixes — dock badge TOML key, desktop_pins example Jul 23, 2026
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