Skip to content

feat: add dark mode reader cleanup setting - #5

Merged
sabraman merged 1 commit into
mainfrom
feature/dark-mode-reader-refresh
May 16, 2026
Merged

feat: add dark mode reader cleanup setting#5
sabraman merged 1 commit into
mainfrom
feature/dark-mode-reader-refresh

Conversation

@sabraman

@sabraman sabraman commented May 16, 2026

Copy link
Copy Markdown
Contributor

Summary\n- bump Dark Mode to 0.1.5\n- add a package-owned Reader cleanup setting for dark reader refresh cadence\n- advertise the new theme descriptor contract in docs\n\n## Validation\n- python3 ../marginalia-sdk/tools/validate_manifest.py --profile publish */manifest.json\n- rebuild package archives with ../marginalia-sdk/tools/build_package.py\n- /Users/sabraman/.local/bin/coderabbit review --plain

Summary by CodeRabbit

  • New Features

    • Added configurable Reader cleanup setting to reduce display ghosting with adjustable timing options (off, every page, or after 5-10 pages).
  • Documentation

    • Updated package documentation with new feature details and release information.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 16, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

Version 0.1.5 of the dark-mode theme adds a configurable readerRefresh setting for periodic cleanup frames to reduce ghosting. The setting is defined in the manifest schema with four options, wired into the theme configuration, documented in both root and theme README files, and all version references are coordinated to 0.1.5.

Changes

Reader Cleanup Feature and Release Coordination

Layer / File(s) Summary
Reader cleanup setting schema and wiring
dark-mode-theme/manifest.json, dark-mode-theme/src/theme.json
Manifest version bumped to 0.1.5. New readerRefresh enum setting added with default 5-pages and options off, every-page, 5-pages, 10-pages. Theme configuration exposes the setting as a "package-setting" property alongside textAntialiasing.
Documentation and version coordination
dark-mode-theme/README.md, README.md
Dark mode README documents the new "Reader cleanup" package setting behavior and updates release archive link to v0.1.5. Root README published archives link updated from v0.1.4 to v0.1.5 dark-mode package.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • marginalia-os/marginalia-examples#4: Both PRs update dark-mode theme refresh/cadence configuration in dark-mode-theme/src/theme.json alongside corresponding manifest.json and README release-version bumps.
  • marginalia-os/marginalia-examples#2: Both PRs update dark-mode-theme/manifest.json to bump theme version and add new manifest-declared settings, along with matching README release-archive link updates.
  • marginalia-os/marginalia-examples#3: Both PRs modify dark-mode theme configuration in dark-mode-theme/manifest.json and dark-mode-theme/src/theme.json with manifest version bumps.

Poem

🐰 A cleanup frame hops through the dark,
Five pages leap, no ghosting mark,
Version bumps align with care,
The reader grows beyond compare!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'feat: add dark mode reader cleanup setting' accurately and concisely describes the main change—adding a new Reader cleanup setting to the dark mode package.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/dark-mode-reader-refresh

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
dark-mode-theme/README.md (1)

14-14: ⚡ Quick win

Consider documenting the enum option behaviors.

The new "Reader cleanup" setting is mentioned, but the user-facing meaning of each option (off, every-page, 5-pages, 10-pages) is not explained. Consider adding a brief explanation of when cleanup frames trigger for each option to help users make an informed choice.

📝 Example documentation enhancement
-- exposes a `Reader cleanup` package setting for periodic dark reader cleanup frames to reduce ghosting
+- exposes a `Reader cleanup` package setting for periodic dark reader cleanup frames to reduce ghosting:
+  - `off`: no cleanup frames
+  - `every-page`: cleanup after each page turn
+  - `5-pages`: cleanup every 5 pages (default)
+  - `10-pages`: cleanup every 10 pages
🤖 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 `@dark-mode-theme/README.md` at line 14, Add brief user-facing descriptions for
the "Reader cleanup" enum options mentioned in README.md: document what each
option (`off`, `every-page`, `5-pages`, `10-pages`) means in terms of when a
dark-reader cleanup frame runs (e.g., never, after every page render, after N
page navigations/frames), include expected effects (reduces ghosting at cost of
extra frames) and the default value; update the "Reader cleanup" line to list
each option and a one-sentence trigger/impact for users to choose appropriately.
🤖 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.

Nitpick comments:
In `@dark-mode-theme/README.md`:
- Line 14: Add brief user-facing descriptions for the "Reader cleanup" enum
options mentioned in README.md: document what each option (`off`, `every-page`,
`5-pages`, `10-pages`) means in terms of when a dark-reader cleanup frame runs
(e.g., never, after every page render, after N page navigations/frames), include
expected effects (reduces ghosting at cost of extra frames) and the default
value; update the "Reader cleanup" line to list each option and a one-sentence
trigger/impact for users to choose appropriately.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 95575ec2-f1f6-4f36-914e-c5045bad453b

📥 Commits

Reviewing files that changed from the base of the PR and between 505ab2a and de57cf8.

📒 Files selected for processing (4)
  • README.md
  • dark-mode-theme/README.md
  • dark-mode-theme/manifest.json
  • dark-mode-theme/src/theme.json

@sabraman
sabraman merged commit 0559886 into main May 16, 2026
2 checks passed
@sabraman
sabraman deleted the feature/dark-mode-reader-refresh branch May 16, 2026 03:13
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