docs: freshness fixes — dock badge TOML key, desktop_pins example, stale investigation status - #48
docs: freshness fixes — dock badge TOML key, desktop_pins example, stale investigation status#48jaylfc wants to merge 5 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 configuration, desktop pin examples, and Linux arm64 binary documentation. The investigation plan records the updater resolution and marks earlier investigation instructions as stale. ChangesDocumentation updates
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 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 SummaryStatus: No Issues Found | Recommendation: Merge Files Reviewed (1 file)
Previous Review Summaries (4 snapshots, latest commit b7b2223)Current summary above is authoritative. Previous snapshots are kept for context only. Previous review (commit b7b2223)Status: No Issues Found | Recommendation: Merge Files Reviewed (2 files)
Previous review (commit 8d6441e)Status: No Issues Found | Recommendation: Merge Files Reviewed (2 files)
Previous review (commit 8c8e20e)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 (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 step-3.7-flash · Input: 27.1K · Output: 3.2K · Cached: 184.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
changed the title
The 2026-06-14 session-handoff doc still read as an open investigation blocked on a user log. CLAUDE.md and CHANGELOG.md's 0.2.10 entry (commit 1ef7c35) already document the fix; this doc was never updated to match, so it contradicted CLAUDE.md's own resolved status.
jaylfc
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/superpowers/plans/2026-06-14-update-stuck-investigation.md`:
- Around line 3-17: Restore the original 2026-06-14 handoff content and preserve
its historical status unchanged. Move the 0.2.10 resolution into a new appended,
dated entry after the original record, following the append-only convention for
this plan document and retaining the existing resolution details there.
- Around line 10-17: Mark the later “START HERE NEXT SESSION” section as
historical and not actionable by adding an explicit “Historical — do not follow”
marker or placing it under an archive heading. Keep the existing handoff content
and append-only structure unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: f2a3d4e0-bc45-47da-b88a-3365ce20c44f
📒 Files selected for processing (1)
docs/superpowers/plans/2026-06-14-update-stuck-investigation.md
| current description. The "START HERE NEXT SESSION" steps below are stale — | ||
| kept for historical record only, per this repo's append-only convention for | ||
| dated plan docs. | ||
|
|
||
| Status at pause (2026-06-14, now historical): **0.2.9 shipped.** One open bug | ||
| under active investigation (in-app "update from Settings" still gets stuck) | ||
| plus one tracked feature (Wayland compositor). This doc is the handoff so a | ||
| fresh session can resume without re-deriving anything. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Mark the archived handoff section itself as historical.
Although this paragraph says the next-session steps are stale, the later START HERE NEXT SESSION heading and shell commands still read as current instructions. Add an explicit “Historical — do not follow” marker to that section or move it under an archive heading.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/superpowers/plans/2026-06-14-update-stuck-investigation.md` around lines
10 - 17, Mark the later “START HERE NEXT SESSION” section as historical and not
actionable by adding an explicit “Historical — do not follow” marker or placing
it under an archive heading. Keep the existing handoff content and append-only
structure unchanged.
…dum instead
CodeRabbit flagged (Major, per this repo's own docs/superpowers/{specs,plans}
path instructions) that the previous commit edited the original 2026-06-14
handoff record in place instead of appending a new dated entry. Restored the
original record unchanged and moved the 0.2.10 resolution note into a new
"Addendum (2026-07-20)" section at the end of the file, consistent with the
append-only convention CLAUDE.md documents for these dated plan docs.
The release build matrix (.github/workflows/release.yml) has built an aarch64-unknown-linux-gnu binary on the ubuntu-22.04-arm runner since the four-platform release pipeline, and install.sh already maps Linux/aarch64 to that target — but the README install line still only advertised macOS arm64/x86_64 and Linux x86_64, leaving out the platform users on arm64 Linux (Raspberry Pi, Asahi, cloud arm64 VMs) actually get a working prebuilt for.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/superpowers/plans/2026-06-14-update-stuck-investigation.md`:
- Around line 116-118: Mark the retained “START HERE NEXT SESSION” handoff as
historical without editing the original dated record, following the append-only
convention. Add a clear “Historical — do not follow” designation immediately
before that section, or place it under an archive heading in the new dated
addendum.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 287c76df-7aca-4e7d-9085-b087694099df
📒 Files selected for processing (2)
README.mddocs/superpowers/plans/2026-06-14-update-stuck-investigation.md
🚧 Files skipped from review as they are similar to previous changes (1)
- README.md
| description. The "START HERE NEXT SESSION" steps above are stale as of this | ||
| addendum — the original record above is left unedited per this repo's | ||
| append-only convention for dated plan docs. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Mark the retained handoff as historical.
Line [116] says that the steps are stale, but the START HERE NEXT SESSION heading and shell commands still appear as active instructions. Add Historical — do not follow before that section, or move the section under an archive heading.
Suggested fix
---
+> **Historical — do not follow.**
+
## ▶ START HERE NEXT SESSION — ask the user these againAs per path instructions: docs/superpowers/{specs,plans}/**: Append new dated design records to docs/superpowers/{specs,plans}; do not retrofit old records.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/superpowers/plans/2026-06-14-update-stuck-investigation.md` around lines
116 - 118, Mark the retained “START HERE NEXT SESSION” handoff as historical
without editing the original dated record, following the append-only convention.
Add a clear “Historical — do not follow” designation immediately before that
section, or place it under an archive heading in the new dated addendum.
Source: Path instructions
1 participant
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).3. Stale "open investigation" status contradicting CLAUDE.md.
docs/superpowers/plans/2026-06-14-update-stuck-investigation.mdstill read as an open bug "blocked on a log from the user." Commit1ef7c35(shipped as 0.2.10) root-caused and fixed it — bothinstall.shandcheck_for_updates()were hitting GitHub's rate-limited REST API for the latest-release lookup, which silently fell back to a slow source build once rate-limited. Commit31846f9updated CLAUDE.md to say so, but never touched this plans doc, leaving the two docs contradicting each other. Added a short "Resolved in 0.2.10" note at the top, per this repo's append-only convention for dated plan docs (kept the original historical body intact below it).4. README install line omitted Linux arm64. The "Prebuilt binary" line under Install said "macOS arm64/x86_64, Linux x86_64" — but the release build matrix (
.github/workflows/release.yml) has built anaarch64-unknown-linux-gnubinary on theubuntu-22.04-armrunner (one of the four platform targets CLAUDE.md itself already describes correctly), andinstall.shmapsLinux/aarch64to that target. The one platform-support line a user actually reads was simply incomplete. Now reads "Linux x86_64/arm64".Scope check
README.mdand one file underdocs/superpowers/plans/— no code/config/CI changes.docs/superpowers/{specs,plans}/*.mduntouched — those are historical design records per the repo's append-only convention.Repo activity (informational, no action taken)
Summary by CodeRabbit
dock_badges.0.2.10.