Skip to content

chore(release): v0.5.5 — Smart Onboarding, About Menu, Bug Reports & Fixes#73

Merged
VariableThe merged 2 commits into
mainfrom
release/v0.5.5
Jun 27, 2026
Merged

chore(release): v0.5.5 — Smart Onboarding, About Menu, Bug Reports & Fixes#73
VariableThe merged 2 commits into
mainfrom
release/v0.5.5

Conversation

@VariableThe

@VariableThe VariableThe commented Jun 27, 2026

Copy link
Copy Markdown
Owner

Overview of Changes in v0.5.5

Added

  • Smart Onboarding & Release Note Routing: Brand new installations now cleanly launch directly into Welcome.md without copying or opening release note files. Existing users upgrading from previous versions automatically receive New Features in v0.5.5.md and are taken directly to it upon opening the new version.
  • Settings Bug Report & About Menu: Added a "Submit a Bug Report" button under System settings linking directly to GitHub Issues. Added an "About" section featuring the app logo, current version display, Ko-fi support link, update checker, and a thank you message.
  • Release Notes: Created pre-written release notes in notes/New Features in v0.5.5.md.

Fixed

  • Windows Onboarding Note Generation: Normalized note path generation across Rust (fs.rs) and TypeScript (useNoteStorage.ts, markdownPlugin.ts, GraphView.tsx) to guarantee forward slashes (/) across all platforms, preventing broken /file links and duplicate notes on Windows.
  • Lockfile & Build Sync: Moved @emnapi WASM fallback packages to devDependencies to ensure deterministic cross-OS lockfile resolution during npm ci.

Performance Reporting (Vite Build Output)

Bundle Size Output:

dist/index.html                                 0.51 kB │ gzip:   0.31 kB
dist/assets/index-Ckvloptw.css                 21.60 kB │ gzip:   4.96 kB
dist/assets/GraphView-BfrVAqH7.js               8.41 kB │ gzip:   3.64 kB
dist/assets/quadtree-B3F59LyK.js              569.99 kB │ gzip: 142.76 kB
dist/assets/react-force-graph-3d-DJdFj_Og.js  774.70 kB │ gzip: 219.15 kB
dist/assets/index-Cf_ExyV7.js                 924.65 kB │ gzip: 304.53 kB

Note on Code Splitting / Dynamic Import Warning: Heavy dependencies like 3D Force Graph (react-force-graph-3d + three.js) and physics (quadtree) are already dynamically imported via lazy(() => import('./GraphView')), successfully splitting them into separate chunks. The main chunk (index.js, 304 kB gzipped) contains React core and the CodeMirror editor engine, ensuring instant text editing responsiveness on launch without loading spinners.


Verification & Pre-PR Checks

  • npm run lint passed cleanly (0 errors)
  • npx vitest run passed (35/35 unit tests passed)
  • npm run build compiled successfully

Summary by CodeRabbit

  • New Features

    • Added smarter onboarding behavior for new installs and existing users, including better routing to version-specific release notes.
    • Added a “Submit a Bug Report” option and expanded the About section.
    • Improved note and link handling on Windows.
  • Bug Fixes

    • Improved app state restoration, including window position persistence.
    • Enhanced login-item sync on macOS.
    • Refined keyboard handling so open panels close before the app hides.
  • Chores

    • Updated the app to version 0.5.5.

@coderabbitai

coderabbitai Bot commented Jun 27, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@VariableThe, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 46 minutes and 53 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more credits in the billing tab to continue.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: dce45341-a644-4001-81c0-55793e2b984a

📥 Commits

Reviewing files that changed from the base of the PR and between 2947cad and b81e303.

📒 Files selected for processing (2)
  • src-tauri/src/commands/fs.rs
  • src/App.tsx
📝 Walkthrough

Walkthrough

The PR bumps the app to v0.5.5, adds release notes, changes onboarding to detect existing users and route to versioned notes, updates startup note selection, and removes the Settings auto-update block while syncing displayed version values.

Changes

v0.5.5 Release and Smart Onboarding

Layer / File(s) Summary
Release metadata and note content
package.json, src-tauri/Cargo.toml, src-tauri/tauri.conf.json, CHANGELOG.md, AUDIT_LOG.md, notes/New Features in v0.5.5.md
Package, Tauri crate, and app config versions move to 0.5.5, and the changelog, audit log, and new release note file are updated for the v0.5.5 release.
Onboarding note provisioning
src-tauri/src/commands/fs.rs
run_onboarding now infers existing users from the onboarding marker or existing markdown notes, removes prior New Features notes, and copies the bundled versioned note only for existing users.
Version note routing in App
src/App.tsx
checkVersion now stores papercache-last-seen-version, prefers the versioned New Features note when the seen version differs, and falls back to Welcome.md only when that note is missing on first run.
Settings version and menu cleanup
src/Settings.tsx, src/setupTests.ts
Settings starts at 0.5.5, removes the Auto-Updates block, and the test mock returns 0.5.5.

Sequence Diagram(s)

sequenceDiagram
  participant run_onboarding
  participant base_directory
  participant app_resources
  run_onboarding->>base_directory: check onboarding marker and scan qualifying .md files
  alt existing user
    run_onboarding->>base_directory: remove older New Features in v*.md files
    run_onboarding->>app_resources: copy New Features in v{version}.md with _up_ fallback
  else new user
    run_onboarding->>base_directory: delete bundled New Features in v*.md files
  end
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Poem

A bunny bonked the version drum,
v0.5.5 went hop-hop-hum.
New Features leapt to greet the day,
and sleepy update buttons scampered away.
🐰✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the release bump and the main feature areas changed in this PR.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch release/v0.5.5

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.

@VariableThe VariableThe changed the title chore(release): bump version to 0.5.5 with smart onboarding and setti… chore(release): v0.5.5 — Smart Onboarding, About Menu, Bug Reports & Fixes Jun 27, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
src-tauri/src/commands/fs.rs (1)

452-476: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

New Features note will reappear on every launch after the user deletes it.

The copy is gated only by is_existing_user && !note_target_path.exists(), not by is_new_version. The note itself tells users "(If you have read this note, feel free to delete it)", but once deleted, the next launch re-satisfies !note_target_path.exists() and silently re-copies it from resources, resurrecting it on every startup until they upgrade again.

Gate the copy on is_new_version (already computed at Line 262) so it is provisioned once per upgrade.

🐛 Proposed fix
-        if is_existing_user && !note_target_path.exists() {
+        if is_existing_user && is_new_version && !note_target_path.exists() {
🤖 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 `@src-tauri/src/commands/fs.rs` around lines 452 - 476, The note provisioning
logic in the fs command re-copies “New Features” notes every launch after
deletion because it only checks `is_existing_user &&
!note_target_path.exists()`. Update the conditional in the note-copy block to
also require `is_new_version` (the flag already computed earlier in the same
flow) so the bundled note is restored only once per upgrade. Keep the cleanup
behavior intact, and make sure the change is applied in the same section that
uses `note_target_path`, `note_filename`, and the resource_dir copy logic.
🤖 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 `@src-tauri/src/commands/fs.rs`:
- Around line 245-261: The existing-user detection in the fs command only checks
top-level markdown files via read_dir on base, so vaults with notes only in
subfolders can be misclassified as new installs. Update the logic around the
version_marker check in the relevant fs helper to use the same recursive note
discovery as get_notes, or otherwise recurse through nested folders when
counting notes, so any .md file anywhere in the vault counts as an existing
user.

In `@src/App.tsx`:
- Around line 112-131: The version marker is being saved too early in App.tsx,
which can prevent the “New Features in v{currentVersion}.md” note from ever
being opened when notes load later. In the logic around
lastSeenVersion/currentVersion, delay the
localStorage.setItem('papercache-last-seen-version', currentVersion) call until
after you have successfully found and selected the target note (or the welcome
note fallback), so the effect can re-run on later notes updates and still route
correctly.

---

Outside diff comments:
In `@src-tauri/src/commands/fs.rs`:
- Around line 452-476: The note provisioning logic in the fs command re-copies
“New Features” notes every launch after deletion because it only checks
`is_existing_user && !note_target_path.exists()`. Update the conditional in the
note-copy block to also require `is_new_version` (the flag already computed
earlier in the same flow) so the bundled note is restored only once per upgrade.
Keep the cleanup behavior intact, and make sure the change is applied in the
same section that uses `note_target_path`, `note_filename`, and the resource_dir
copy logic.
🪄 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

Run ID: 6f16a5da-ba72-4efd-9e95-ea9946147ce5

📥 Commits

Reviewing files that changed from the base of the PR and between 54b973d and 2947cad.

⛔ Files ignored due to path filters (1)
  • src-tauri/Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (10)
  • AUDIT_LOG.md
  • CHANGELOG.md
  • notes/New Features in v0.5.5.md
  • package.json
  • src-tauri/Cargo.toml
  • src-tauri/src/commands/fs.rs
  • src-tauri/tauri.conf.json
  • src/App.tsx
  • src/Settings.tsx
  • src/setupTests.ts

Comment thread src-tauri/src/commands/fs.rs Outdated
Comment thread src/App.tsx
…ection, note provisioning, and routing effect timing
@VariableThe VariableThe merged commit 0a49515 into main Jun 27, 2026
4 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