Core and desktop comments describe the code to a stranger (#6224)

Milestone 546 "Bring the repo to the comment standard (rule 32) and
compose defaults (rule 198)", step #6224 "Comment standard sweep: Rust
core and desktop client".

Doc comments and comments across inkwell-core, the Tauri app and
desktop/packaging now say what the code does and the non-obvious why in
the present tense. Gone: milestone tags (M10.x, M11.3, M13, M304, M315,
M314, milestone 325), issue and Scribe-note numbers, family-idea and
family-rule citations, the run numbers and commit hashes behind past
bugs, and the narration of what used to be (the stable channel before it
held its own bundles, CARGO_PKG_VERSION as the shown version, the
MANIFEST_TAG split, the store's missing tests, the old PKGBUILD). The
schema's migration notes keep what each step does and why, without
"until now". The forge is called the forge rather than Forgejo.

Hazards stay as facts: the dev-rolling tag that must not shadow the
branch, the manifest matched on this build's version, the APK's fixed
name surviving the prune, the LIKE guard in v9, -wal/-shm moving with
the renamed store, panic = abort ending the app.

34 files, comments only: a comment-stripping diff of every changed file
against HEAD is identical.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

desktop/packaging/appimage/debundle-graphics.sh

@@ -6,7 +6,7 @@
 # libwayland-* into usr/lib. On many end-user systems (Arch/CachyOS, NVIDIA,
 # Wayland) those bundled copies clash with the running kernel driver + Mesa and
 # abort with "Could not create default EGL display: EGL_BAD_PARAMETER" -> a black
-# window (issue 2021). They load before any renderer choice, so the runtime env
+# window. They load before any renderer choice, so the runtime env
 # fallbacks (WEBKIT_DISABLE_DMABUF_RENDERER etc.) cannot rescue it. Per the
 # AppImage excludelist these libraries MUST come from the host. We strip exactly
 # that graphics/display subset -- keeping webkit/gtk/javascriptcore bundled for

desktop/packaging/arch/package-prebuilt.sh

@@ -3,8 +3,8 @@
 # Build a PREBUILT Arch package (.pkg.tar.zst) from the binary the desktop CI job
 # already compiled — no makepkg, no Arch container, no second Rust build.
 #
-# WHY prebuilt: the source PKGBUILD this replaces required every user to install
-# rust + nodejs + npm and compile for minutes before they could open the app.
+# WHY prebuilt: a source PKGBUILD would make every user install rust + nodejs +
+# npm and compile for minutes before they could open the app.
 # Distribution means shipping a package people can just install, so the one-command
 # installer (install.sh) can `pacman -U` a real native package on Arch/CachyOS
 # instead of falling back to the AppImage.
@@ -14,8 +14,8 @@
 # SONAME at runtime, and those sonames are identical on both distros; SQLite is
 # compiled in (rusqlite "bundled"). glibc symbol versioning is forward-compatible,
 # and we build on Debian's older glibc and run on Arch's newer one — the safe
-# direction. Using the host's graphics stack is also exactly what keeps issue 2021
-# (bundled-lib EGL_BAD_PARAMETER black window) fixed.
+# direction. Using the host's graphics stack is also what avoids the bundled-lib
+# EGL_BAD_PARAMETER black window.
 #
 # A .pkg.tar.* is just a tar whose FIRST entry is .PKGINFO, so we assemble it
 # directly rather than nesting an Arch container over the docker socket.
@@ -33,10 +33,9 @@ BINARY="$REPO_ROOT/target/release/inkwell"
 OUT_DIR="${1:-$REPO_ROOT/target/release/bundle/arch}"
 
 PKGNAME="inkwell"
-# The names this package used to ship under: `thoughtsync` until the app became
-# Inkwell (Scribe note 5071), `thoughtsync-desktop` before that. pacman needs both
-# conflict and replace to retire them: without them a `pacman -U` of the renamed
-# package installs ALONGSIDE the old one (issue 2075).
+# Earlier names of this package: `thoughtsync` and `thoughtsync-desktop`. pacman
+# needs both conflict and replace to retire them: without them a `pacman -U`
+# installs ALONGSIDE the old one.
 REPLACES=(thoughtsync thoughtsync-desktop)
 PKGREL=1
 PKGDESC="Inkwell desktop — local-first Keep-style thought capture"
@@ -58,11 +57,9 @@ DEPENDS=(webkit2gtk-4.1 gtk3)
 
 # Single source of truth for the version: the SAME helper the bundle build uses.
 #
-# It used to read tauri.conf.json directly, which was right until dev builds began
-# overriding the version on the command line (M10.9) — the file still says 0.1.0, so
-# the pacman package came out stamped 0.1.0 around a binary reporting 0.1.132. A
-# package that lies about its version is exactly what makes a later "which build is
-# this?" question unanswerable.
+# Not tauri.conf.json: dev builds override the version on the command line and the
+# file says 0.1.0, so reading it would stamp the package with a version its binary
+# doesn't report.
 # `|| true` so a miss falls through to the explicit error below rather than
 # aborting on pipefail with no explanation.
 # The ORDERING KEY: pacman compares this, and it must match the filename the
@@ -127,7 +124,7 @@ INSTALLED_SIZE="$(du -sb "$STAGE" | cut -f1)"
 # pacman uses .MTREE for `pacman -Qkk` file verification; it is NOT required to
 # install, and generating it needs bsdtar (libarchive-tools), which the Debian CI
 # image may not carry. Emit it when we can, skip loudly when we can't, rather
-# than adding an apt install to the job (rule 5: the image is the toolchain).
+# than adding an apt install to the job (the image is the toolchain).
 MTREE_ENTRY=()
 if command -v bsdtar >/dev/null 2>&1; then
   ( cd "$STAGE" && LANG=C bsdtar -czf .MTREE --format=mtree \

desktop/packaging/deb/verify.sh

@@ -3,9 +3,8 @@
 # Verify the .deb that `cargo tauri build` produced is a correct, installable
 # native package — BEFORE the one-command installer starts handing it to people.
 #
-# WHY: install.sh prefers the .deb on every Debian/Ubuntu machine, but until now
-# nothing had ever inspected it, let alone installed it. Its Depends line was
-# entirely whatever tauri inferred, unread. The failure mode we're guarding is a
+# WHY: install.sh prefers the .deb on every Debian/Ubuntu machine, and its Depends
+# line is whatever tauri infers. The failure mode we're guarding is a
 # user running install.sh and getting either an apt resolution error or an app
 # that installs and then won't launch because a library it needs was never
 # declared.
@@ -14,10 +13,9 @@
 #   1. Print the control file + contents — the generated metadata becomes ground
 #      truth in the build log instead of an assumption.
 #   2. Naming: the binary is /usr/bin/inkwell and the generated .desktop
-#      entry's StartupWMClass matches it. The app used to identify itself three
-#      different ways depending on install channel (issue 2075); this is what
-#      keeps the .deb — the only channel whose entry Tauri generates for us —
-#      from drifting away from the two we write by hand.
+#      entry's StartupWMClass matches it. This keeps the .deb — the only channel
+#      whose entry Tauri generates for us — from drifting away from the two we
+#      write by hand.
 #   3. dpkg-shlibdeps: the canonical Debian answer for "what does this ELF
 #      actually need". Compared against what the package declares.
 #   4. Every declared dependency resolves to a real package in apt (catches a
@@ -28,7 +26,7 @@
 #
 # Check 5 is opportunistic on purpose: the build image is not guaranteed to carry
 # a docker CLI, and adding one at job time would violate "the image is the
-# toolchain" (rule 5). Checks 1-4 are self-contained and always run.
+# toolchain". Checks 1-4 are self-contained and always run.
 set -euo pipefail
 
 SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
@@ -74,10 +72,10 @@ echo "    (binary: ${BIN#"$WORK/root"})"
 # purpose — this literal IS the contract the three install channels are held to.
 #
 # The control file's `Package:` field is held to it too. tauri-bundler derives it
-# as kebab-case(productName) with no override, which split "ThoughtSync" into
-# `thought-sync` (issue 2075). "Inkwell" has no hump to split, so the package and
-# the command finally agree, and a productName that brought the split back would
-# also break the `conflicts`/`replaces` retiring the old package.
+# as kebab-case(productName) with no override, so a productName with a hump
+# ("ThoughtSync") splits into `thought-sync`. "Inkwell" has none, so the package
+# and the command agree; a productName that brought a split back would also break
+# the `conflicts`/`replaces` retiring the old package.
 CANON="inkwell"
 
 package="$(dpkg-deb -f "$DEB" Package 2>/dev/null || true)"
@@ -89,8 +87,8 @@ installed_bin="${BIN#"$WORK/root"}"
   note_fail "binary is at $installed_bin, expected /usr/bin/$CANON (mainBinaryName in tauri.conf.json)."
 
 # Tauri generates this entry from the binary name, so a mismatch means the config
-# and the bundler have diverged — exactly the drift that made the app group under
-# a different taskbar icon depending on how it was installed.
+# and the bundler have diverged — the drift that groups the app under a different
+# taskbar icon depending on how it was installed.
 entry="$(find "$WORK/root/usr/share/applications" -name '*.desktop' -print -quit 2>/dev/null || true)"
 if [ -z "$entry" ]; then
   note_fail "no .desktop entry in the package — the app would not appear in any menu."

desktop/packaging/install.sh

@@ -16,12 +16,8 @@
 #   stable (default) — the rolling build from every merge to `main`.
 #   dev              — the rolling build from every green push to `dev`.
 # Both are fixed-tag releases: the tag never moves and the assets are pruned to the
-# current build, so the tag alone names the newest one. `stable` only became one in
-# M314 step 3, when `main` started publishing — before that it was a manifest-only
-# pointer at whatever `v*` tag somebody had last cut, and this script carried a
-# fallback that chased the `v*` release its manifest named. That came out once
-# `main` had published to `stable` for real (`b6673c6`); the two channels are the
-# same shape now and nothing here should special-case one of them again.
+# current build, so the tag alone names the newest one. The two channels are the
+# same shape, and nothing here special-cases either.
 # Pick one with `--channel dev` or `INKWELL_CHANNEL=dev`. Through a pipe the options go
 # after a `--`:  curl -fsSL <url> | sh -s -- --channel dev
 #
@@ -36,7 +32,7 @@
 #   * everything else (Fedora/openSUSE/…) -> the de-bundled AppImage,
 #     installed user-locally (no sudo). The AppImage's graphics libs are
 #     stripped in CI (see debundle-graphics.sh), so it uses the host GPU stack
-#     and renders where a stock Tauri AppImage would black-window (issue 2021).
+#     and renders where a stock Tauri AppImage would black-window.
 #
 # POSIX sh (dash-safe) so `curl … | sh` works everywhere. Dependency-light and
 # auditable on purpose — read it before you pipe it.
@@ -122,9 +118,8 @@ if [ -n "$server" ]; then
 fi
 
 # --- architecture gate ------------------------------------------------------
-# Only x86_64 is built today; arm64 will be added when the CI matrix grows. The
-# release-asset naming carries the arch, but since only one arch ships now we
-# match by file extension below and just guard the arch here.
+# Only x86_64 is built. The release-asset naming carries the arch, but with one
+# arch shipping we match by file extension below and just guard the arch here.
 arch="$(uname -m)"
 case "$arch" in
   x86_64 | amd64) : ;;
@@ -148,7 +143,7 @@ fetch() {
 # The download against the digest its server published, BEFORE it reaches pacman,
 # dpkg or a menu entry: a truncated file installs as something broken rather than
 # failing. The forge path publishes no digest per bundle, so it passes an empty one
-# and this checks nothing there; that is the forge path exactly as it always was.
+# and this checks nothing there.
 verify() {
   [ -n "$2" ] || return 0
   if have sha256sum; then
@@ -231,8 +226,8 @@ say "Finding the latest Inkwell build on the $channel channel…"
 # channel — which is exactly what an installer wants and what the in-app updater
 # already reads.
 # The channel's RELEASE TAG, which is not always its name: `dev` publishes on the
-# tag `dev-rolling`, because a tag called `dev` shadowed the branch of the same name
-# and broke `git push origin dev` (Scribe #2184). Same mapping as
+# tag `dev-rolling`, because a tag called `dev` would shadow the branch of the same
+# name and break `git push origin dev`. Same mapping as
 # packaging/channel-tag.sh — inlined because this script is fetched alone through a
 # pipe and has nothing to source.
 case "$channel" in
@@ -269,9 +264,9 @@ revoke_token() {
 }
 
 # Tell the app which channel it was installed from. The installer is the only thing
-# that knows, and without this the app kept its own `stable` default and a dev install
-# checked the stable feed — which advertises an OLDER version — reporting "up to date"
-# forever (issue 2183).
+# that knows; without this the app keeps its own `stable` default, and a dev install
+# would check the stable feed, which advertises an OLDER version, and report "up to
+# date" forever.
 #
 # A plain file rather than a write into the app's SQLite store: shell has no business
 # knowing that schema, and a file it can't misread is the narrowest possible contract.
@@ -282,7 +277,7 @@ revoke_token() {
 # both sides hardcode it, so a change to the identifier has to change both.
 #
 # From a server, the sibling `install-server` is written instead: which server the app
-# came from, for the updater to follow (milestone 325, step 6). The channel marker is
+# came from, for the updater to follow. The channel marker is
 # left alone on that path, because a server's channel is whatever its image was built
 # with and nothing here can know it.
 record_channel() {
@@ -323,8 +318,8 @@ native_update_note() {
 
 # --- native pacman path (Arch/CachyOS/Manjaro) ------------------------------
 # Preferred over the AppImage on Arch: pacman pulls webkit2gtk-4.1 itself and the
-# app then runs against the host graphics stack, which is what keeps the
-# EGL_BAD_PARAMETER black window (issue 2021) from coming back. It also means the
+# app then runs against the host graphics stack, which is what avoids the
+# EGL_BAD_PARAMETER black window. It also means the
 # app is tracked by the package manager and uninstalls cleanly.
 if have pacman && [ -n "$pkg_url" ]; then
   say "Arch-family system detected — installing the native pacman package"

desktop/packaging/publish-release.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 #
-# Publish the built desktop bundles as assets on a Fabled-Git (Forgejo) Release.
+# Publish the built desktop bundles as assets on a Fabled-Git Release.
 #
 # WHY: CI Actions artifacts are ephemeral, per-run, and auth-gated — useless as a
 # distribution/fetch target. The install script (install.sh) and the in-app
@@ -9,9 +9,8 @@
 # and each asset has a permanent browser_download_url.
 #
 # WHEN: CI-only, and ONLY on a `v*` tag build (the workflow gates this step with
-# `if: startsWith(github.ref, 'refs/tags/v')`). Cutting the tag is the operator's
-# action (rule 2) — this script never creates a tag, it only publishes a Release
-# for a tag that already exists.
+# `if: startsWith(github.ref, 'refs/tags/v')`). This script never creates a tag; it
+# only publishes a Release for a tag that already exists.
 #
 # The build + de-bundle steps run first; this consumes their output:
 #   target/release/bundle/appimage/*.AppImage  (de-bundled)
@@ -20,7 +19,7 @@
 #   target/x86_64-pc-windows-msvc/release/bundle/nsis/*.exe
 #
 # Instance-agnostic: server + repo come from the runner's github.* context
-# (Forgejo populates them for compatibility), so nothing is hardcoded to one host.
+# (the forge populates them for compatibility), so nothing is hardcoded to one host.
 #
 # Idempotent: re-running for the same tag reuses the existing Release and
 # replaces same-named assets, so a re-run (or workflow_dispatch retry) is safe.
@@ -34,7 +33,7 @@ set -euo pipefail
 # The release to publish to. Defaults to the pushed tag (the versioned, stable
 # case). The channel publish steps call this with the channel's fixed tag —
 # `stable`, or `dev-rolling` for the dev channel (packaging/channel-tag.sh) — to
-# maintain a rolling release whose tag never moves, because Forgejo has no
+# maintain a rolling release whose tag never moves, because the forge has no
 # `/releases/latest/download/<asset>` route for an updater to point at.
 RELEASE_TAG="${RELEASE_TAG:-$GITHUB_REF_NAME}"
 RELEASE_PRERELEASE="${RELEASE_PRERELEASE:-false}"
@@ -57,13 +56,13 @@ shopt -s nullglob
 # can see the other's bundles. The release is created once and reused (409 path).
 # The `.sig` files are the updater's whole trust story — a bundle published without
 # its signature is one the app will refuse, so they ship together or not at all.
-# They only exist when the build ran with a signing key (M10.9); nullglob drops
-# them silently otherwise, which is the correct behaviour for an unsigned build.
+# They only exist when the build ran with a signing key; nullglob drops them
+# silently otherwise, which is the correct behaviour for an unsigned build.
 # The Android client publishes here too, from its own job and its own workspace
-# — the same nullglob arrangement that already lets the Linux and Windows jobs
-# share one release. Its two files are staged under android/dist by the workflow:
-# a STABLY NAMED apk (a fixed name is the whole point of the fixed `dev` tag —
-# Forgejo has no /releases/latest/download route) and the sidecar the server reads
+# — the same nullglob arrangement that lets the Linux and Windows jobs share one
+# release. Its two files are staged under android/dist by the workflow: a STABLY
+# NAMED apk (a fixed name is the whole point of the fixed `dev` tag — the forge
+# has no /releases/latest/download route) and the sidecar the server reads
 # its version out of, because an APK keeps that in a binary manifest.
 ASSETS=(
   "$BUNDLE_ROOT"/appimage/*.AppImage
@@ -77,8 +76,7 @@ ASSETS=(
 )
 # nullglob drops PATTERNS that match nothing — it does nothing for a path with no
 # wildcard in it, which stays in the array as a literal and reaches curl as a file
-# that isn't there (exit 26). The Android entries above are exactly that shape, and
-# adding them broke the desktop publish that had been working. Filter on existence
+# that isn't there (exit 26). The Android entries above are that shape. Filter on existence
 # instead, which is what the array actually means and covers every entry rather
 # than only the ones that happen to contain a `*`.
 present=()
@@ -120,20 +118,20 @@ first_id() { grep -oE '"id"[[:space:]]*:[[:space:]]*[0-9]+' | head -1 | grep -oE
 # — otherwise someone following the instructions here lands on a tagged build and
 # wonders why the version they were sent isn't what they got.
 #
-# Both CHANNELS are rolling pointer releases (M314 step 3): `dev` republishes on
+# Both CHANNELS are rolling pointer releases: `dev` republishes on
 # every green push to dev, `stable` on every merge to main. Each says so, because a
 # release that prunes its own assets behaves differently from a versioned one and a
 # reader deserves to know which they are looking at.
 # Keyed on the TAG, which for the dev channel is `dev-rolling`, not `dev` — a tag
-# named `dev` shadowed the branch (Scribe #2184). CHANNEL_LABEL is the name a person
-# reads in the release title, so the rename does not leak into it.
+# named `dev` would shadow the branch. CHANNEL_LABEL is the name a person reads in
+# the release title, so the tag name doesn't leak into it.
 if [ "$TAG" = "dev-rolling" ]; then
   CHANNEL_LABEL='dev (rolling)'
   INSTALL_TAIL='sh -s -- --channel dev'
   # Backticks BARE, not `\``. The heredoc below is unquoted, so there the backslash
   # is the shell's — it suppresses command substitution and never reaches the JSON.
   # Here single quotes already do that job, so a backslash would survive into the
-  # body as `\``, which is not a legal JSON escape: Forgejo answers 422.
+  # body as `\``, which is not a legal JSON escape: the forge answers 422.
   CHANNEL_NOTE='\n\nThis is the rolling **dev** channel: republished on every green push to `dev`, and pruned to the current build.'
 elif [ "$TAG" = "stable" ]; then
   CHANNEL_LABEL='stable'
@@ -155,11 +153,11 @@ JSON
 
 # An explicit body, replacing the install instructions above.
 #
-# Used by the RELEASE lane, whose job is a changelog rather than artifacts (M314
-# step 7). It goes through this script rather than making its own API calls so that
-# the create-or-PATCH-on-409 path is shared: a fixed-tag release that only ever
-# POSTs keeps whatever text its FIRST build wrote, which is #2182 exactly, and
-# re-implementing that correctly in a second place is how it comes back.
+# Used by the RELEASE lane, whose job is a changelog rather than artifacts. It goes
+# through this script rather than making its own API calls so that the
+# create-or-PATCH-on-409 path is shared: a fixed-tag release that only ever POSTs
+# keeps whatever text its FIRST build wrote, and a second copy of that path is one
+# more place to get it wrong.
 #
 # CONTRACT: already JSON-escaped, without surrounding quotes. The caller knows
 # whether it has a JSON encoder; this script cannot assume python3 is on PATH in
@@ -190,7 +188,7 @@ existing="$(api GET "$API/releases/$RELEASE_ID/assets")"
 # --- upload each asset ------------------------------------------------------
 for asset in "${ASSETS[@]}"; do
   name="$(basename "$asset")"
-  # If an asset with this name already exists, delete it first (Forgejo rejects
+  # If an asset with this name already exists, delete it first (the forge rejects
   # a duplicate name). Match the "id" that precedes this asset's "name".
   old_id="$(printf '%s' "$existing" \
     | grep -oE "\"id\"[[:space:]]*:[[:space:]]*[0-9]+[^}]*\"name\"[[:space:]]*:[[:space:]]*\"$name\"" \

desktop/packaging/write-manifest.sh

@@ -30,15 +30,8 @@ set -euo pipefail
 # wrong build, and there is nothing downstream that could catch it.
 : "${DISPLAY_VERSION:?DISPLAY_VERSION is required (the human-readable version)}"
 
-# The manifest is published to the release that HOLDS the bundles. There is no
-# second place any more.
-#
-# There used to be: `MANIFEST_TAG` let the manifest live on a `stable` pointer
-# release while the bundles sat on a versioned `v*` one, because the app can only
-# read a URL that never changes and a versioned tag is not that. M314 step 3 made
-# `stable` a rolling release that holds its own bundles, exactly like `dev`, so the
-# split had nothing left to bridge — and a parameter that can only ever be passed
-# its own default is a branch nobody exercises and a comment that goes stale.
+# The manifest is published to the release that HOLDS the bundles: both channels
+# are rolling releases that hold their own bundles, so there is no second place.
 
 API="$GITHUB_SERVER_URL/api/v1/repos/$GITHUB_REPOSITORY"
 AUTH=(-H "Authorization: token $GITHUB_TOKEN")
@@ -66,12 +59,12 @@ platform_entry() {
   local target="$1" pattern="$2" bundle sig_name
   # Matched on THIS build's version, not just the file extension.
   #
-  # The rolling dev release accumulates every build's assets, and picking the first
-  # extension match returned the OLDEST one — so the manifest advertised the new
-  # version while pointing at an old binary. The client would install the older
-  # build, still be told the newer version was available, and update forever. The
-  # signature check couldn't catch it either: the old bundle's signature is
-  # perfectly valid FOR THE OLD BUNDLE.
+  # The rolling dev release accumulates every build's assets, and the first
+  # extension match would be the OLDEST one: the manifest would advertise the new
+  # version while pointing at an old binary, and the client would install the older
+  # build, still be told the newer one was available, and update forever. The
+  # signature check can't catch it: the old bundle's signature is valid FOR THE OLD
+  # BUNDLE.
   bundle="$(printf '%s\n' "$names" | grep -F "_${APP_VERSION}_" | grep -E "$pattern" | head -1 || true)"
   # A hard failure, not a skip: reaching here means this platform's build didn't
   # upload, and the whole point is to never advertise a bundle that isn't there.
@@ -125,7 +118,7 @@ cat "$work/latest.json"
 # the one `publish-release.sh` created or refreshed moments earlier, so it is
 # guaranteed to exist by the time this runs.
 
-# Replace rather than duplicate: Forgejo rejects a second asset with the same name,
+# Replace rather than duplicate: the forge rejects a second asset with the same name,
 # and these files are rewritten on every publish by design.
 replace_asset() {
   local path="$1" name="$2" escaped old_id
@@ -191,8 +184,7 @@ if [ "${PRUNE_OLD_ASSETS:-false}" = "true" ]; then
         # The Android client is on that list for a second reason too: it is built
         # by a DIFFERENT workflow with its own run number, so its version never
         # matches $APP_VERSION here and a version-stamped name would be pruned on
-        # every desktop push regardless. That is exactly what happened on run
-        # 4098, which swept the APK run 4092 had just published.
+        # every desktop push regardless.
         case "$asset_name" in
           latest.json|inkwell-desktop.json|inkwell.apk|inkwell-android.json) continue ;;
           *"$APP_VERSION"*) continue ;;

desktop/src-tauri/Cargo.toml

@@ -4,14 +4,7 @@ name = "inkwell-desktop"
 #
 # Cargo requires a version here, and Tauri reads one from `tauri.conf.json` — both
 # are overridden per build by `cargo tauri build --config '{"version": ...}'` with
-# the value `packaging/version.sh key desktop` derives. See #3144.
-#
-# It used to matter: the old scheme took its base from this line and appended the CI
-# run number on dev, so `0.2.<run>` on dev sat against a bare `0.2.0` on main and
-# every dev build outranked every stable one. The remedy was "remember to bump the
-# minor before tagging" — documented in a comment, enforced nowhere, and #2183 is
-# what that looked like in the field. A scheme needing a human to remember something
-# before each release has not removed the decision, only hidden it.
+# the value `packaging/version.sh key desktop` derives.
 version = "0.2.0"
 description = "Inkwell desktop — local-first Keep-style thought capture"
 authors = ["bvandeusen"]
@@ -24,9 +17,8 @@ autobins = false
 # App logic lives in the library (Tauri v2 pattern: a single `run()` entry point);
 # main.rs is a thin shim.
 #
-# rlib only. The staticlib/cdylib types existed for Tauri mobile, which Android no
-# longer uses — it is a native Kotlin client over `inkwell-core` instead
-# (Scribe note 2730), and the .so it loads is built from that crate, not this one.
+# rlib only: Android is a native Kotlin client over `inkwell-core`, and the .so it
+# loads is built from that crate, not this one.
 [lib]
 name = "inkwell_desktop_lib"
 crate-type = ["rlib"]
@@ -37,7 +29,7 @@ crate-type = ["rlib"]
 # name. (Written without braces on purpose: `tauri android init` round-trips this
 # file through a TOML serializer that reformats brace tokens inside comments.)
 # So the canonical name has to be carried by the build target itself, not just by
-# the path it gets installed to (issue 2075). The crate is `inkwell-desktop`, so
+# the path it gets installed to. The crate is `inkwell-desktop`, so
 # the executable is named here rather than inferred. `inkwell` is also fixed under
 # kebab-casing, which the AppImage bundler applies to the binary name on its way in.
 [[bin]]
@@ -49,7 +41,7 @@ tauri-build = { version = "2", features = [] }
 
 [dependencies]
 # The framework-free client core: local SQLite store + sync engine. Shared with the
-# Android client, which binds the same crate through uniffi (Scribe note 2730).
+# Android client, which binds the same crate through uniffi.
 inkwell-core = { path = "../../core" }
 
 tauri = { version = "2", features = [] }
@@ -59,10 +51,10 @@ log = { workspace = true }
 # Startup + operation logging to stdout AND a persistent file, so portability
 # issues are diagnosable from any environment.
 tauri-plugin-log = "2"
-# In-app updates (M10.9). Signature verification is minisign; the public half lives
-# in tauri.conf.json and the private half only ever as a CI secret. Desktop only —
+# In-app updates. Signature verification is minisign; the public half lives in
+# tauri.conf.json and the private half only ever as a CI secret. Desktop only —
 # the plugin declares android support level "none", which is why the Android client
-# gets a server-served update path instead (Scribe note 2725).
+# gets a server-served update path instead.
 tauri-plugin-updater = "2"
 
 # The system-wide quick-capture hotkey. Desktop only by nature — Android has no
@@ -70,7 +62,7 @@ tauri-plugin-updater = "2"
 # intent filter instead.
 tauri-plugin-global-shortcut = "2"
 
-# System notifications for due reminders (#5171), raised from the reminder worker in
+# System notifications for due reminders, raised from the reminder worker in
 # Rust. The page's own `Notification` goes nowhere in WebKitGTK, and the page's
 # timer only runs while its window does. Used from Rust only, so no capability
 # grants it to the webview.

desktop/src-tauri/src/autosync.rs

@@ -1,10 +1,6 @@
-//! The desktop syncs on its own (#5167).
-//!
-//! Until this existed, the only thing that ever called the sync engine was the
-//! "Sync now" button on the Sync screen. A linked desktop sat on its edits until
-//! someone went looking for that button, and never heard about a note written on
-//! the phone. Android has done better from the start (a periodic WorkManager job,
-//! plus a flush when the app leaves the foreground); this is the desktop's version.
+//! The desktop syncs on its own, so a linked desktop sends its edits and hears about
+//! notes written elsewhere without anyone pressing "Sync now". Android does the same
+//! with a periodic WorkManager job and a flush when the app leaves the foreground.
 //!
 //! ## When a cycle runs
 //!

desktop/src-tauri/src/commands/local.rs

@@ -1,7 +1,7 @@
 //! Tauri command surface for the local store — the offline mirror of the REST API
 //! the frontend's repository seam calls. Each command locks the shared connection and
 //! delegates to `store`; errors are stringified for the JS boundary. adapters/local.ts
-//! (M10.5) invokes these.
+//! invokes these.
 
 use serde_json::Value;
 use tauri::State;
@@ -109,7 +109,7 @@ pub fn notes_update_item(
     store::update_item(&conn, &id, &item_id, &changes).map_err(|e| e.to_string())
 }
 
-/// Attach a file to a note, online or not (#5168).
+/// Attach a file to a note, online or not.
 ///
 /// The file's bytes are the raw IPC body — a JSON number array would be several
 /// times the file's size — and its note, name and type ride in headers. Header values

desktop/src-tauri/src/commands/sync.rs

@@ -1,7 +1,7 @@
-//! Tauri commands for pairing with a server (M10.7a).
+//! Tauri commands for pairing with a server.
 //!
 //! Linking is opt-in and reversible; the app is fully usable having never touched
-//! any of this. The Settings UI (M10.7e) drives these.
+//! any of this. The Sync screen drives these.
 
 use serde::{Deserialize, Serialize};
 use tauri::{AppHandle, State};
@@ -167,7 +167,7 @@ pub fn sync_has_pending(db: State<'_, Db>) -> Result<bool, String> {
     push::has_pending(&conn).map_err(|e| e.to_string())
 }
 
-// --- sharing (#5175) -----------------------------------------------------------
+// --- sharing -------------------------------------------------------------------
 //
 // The Share dialog's calls, straight to the linked server. Unlinked, each answers
 // `sharing::NEEDS_SERVER`, which the dialog shows as it is.
@@ -184,7 +184,7 @@ pub async fn shares_list(note_id: String, db: State<'_, Db>) -> Result<Vec<NoteS
     sharing::list(&db, &url, &token, &note_id).await
 }
 
-/// Share with a person (`user_id`) or a group (`group_id`, #5177): exactly one.
+/// Share with a person (`user_id`) or a group (`group_id`): exactly one.
 #[tauri::command]
 pub async fn shares_share(
     note_id: String,

desktop/src-tauri/src/crossover.rs

@@ -1,6 +1,6 @@
 //! One-time move of a ThoughtSync install's data into Inkwell's.
 //!
-//! The app was renamed ThoughtSync → Inkwell (Scribe note 5071), and the Tauri
+//! The app was renamed ThoughtSync → Inkwell, and the Tauri
 //! identifier with it. The app-data dir is named after the identifier, so the
 //! renamed app looks in `com.fabledsword.inkwell` and would start EMPTY beside the
 //! old `com.fabledsword.thoughtsync`, which still holds every note. Local-first means
@@ -12,7 +12,7 @@
 //! hold committed writes not yet checkpointed into the main file, and a database
 //! renamed without them silently loses them.
 //!
-//! A removable shim, deliberately (family rule 22): delete this module and its one
+//! A removable shim, deliberately: delete this module and its one
 //! call in `lib.rs` once no install is still on the old identifier.
 
 use std::fs;
@@ -42,7 +42,7 @@ pub enum Outcome {
 ///
 /// Entry by entry rather than renaming the directory, because `new_dir` can already
 /// exist without a store: the installer writes its channel marker there before the
-/// app first runs (update.rs, issue 2183), and the webview may create its own files
+/// app first runs (update.rs), and the webview may create its own files
 /// before setup. Anything already in `new_dir` wins; the old copy of it is left in
 /// place, and so is `old_dir` itself unless it ends up empty.
 pub fn adopt_legacy_data(old_dir: &Path, new_dir: &Path) -> io::Result<Outcome> {

desktop/src-tauri/src/integration.rs

@@ -94,7 +94,7 @@ pub fn integrate_desktop() -> Result<IntegrationStatus, String> {
     // StartupWMClass is the exception: it must be the BINARY name, because GTK
     // derives the window's WM_CLASS from the executable and the desktop matches the
     // two to group the taskbar icon. Not the product name, and not this AppImage's
-    // filename — AppRun execs `usr/bin/inkwell` inside it (issue 2075).
+    // filename — AppRun execs `usr/bin/inkwell` inside it.
     let entry = desktop_entry_path().ok_or("Cannot resolve the applications dir.")?;
     if let Some(parent) = entry.parent() {
         fs::create_dir_all(parent).map_err(|e| format!("create applications dir: {e}"))?;

desktop/src-tauri/src/lib.rs

@@ -1,7 +1,7 @@
 //! Inkwell desktop (Tauri v2).
 //!
 //! The window loads the shared Vue 3 frontend (`../../frontend`), which reaches the
-//! store and sync engine through the `frontend/src/adapters/` seam (M10.3) over Tauri
+//! store and sync engine through the `frontend/src/adapters/` seam over Tauri
 //! `invoke`.
 //!
 //! This crate is the DESKTOP WRAPPER, not the core. The on-device SQLite store and
@@ -20,26 +20,23 @@ mod update;
 /// The build a PERSON reads, baked in by the desktop lane at compile time.
 ///
 /// Lives at the crate root because it has two readers — `config_get`, which puts it
-/// in the UI, and `log_environment`, which puts it in the log — and this repo has
-/// spent several issues on one fact held in two places (2181, 2182, 2183).
+/// in the UI, and `log_environment`, which puts it in the log — and one fact belongs
+/// in one place.
 ///
 /// `option_env!`, not `env!`: a local `cargo tauri build` sets nothing, and this has
 /// to keep compiling. `None` becomes "unknown" at each call site rather than a
-/// plausible-looking default — note 3127 §5 makes this string the only answer to
-/// "which build is this?" now that there are no version tags, so there is nothing
-/// left to contradict it if it lies. An honest "I cannot say" is the only safe wrong
-/// answer.
+/// plausible-looking default: with no version tags, this string is the only answer to
+/// "which build is this?", so an honest "I cannot say" is the only safe wrong answer.
 ///
-/// NOT `CARGO_PKG_VERSION`, which both readers used to use, and which was wrong on
-/// every build ever shipped: `cargo tauri build --config '{"version": ...}'`
-/// overrides `tauri.conf.json`, not Cargo's own metadata, so the literal `0.2.0` in
-/// Cargo.toml is what reached the UI and the log regardless of what was built.
+/// NOT `CARGO_PKG_VERSION`: `cargo tauri build --config '{"version": ...}'` overrides
+/// `tauri.conf.json`, not Cargo's own metadata, so Cargo.toml's literal would reach
+/// the UI and the log regardless of what was built.
 ///
 /// NOT the ordering key either. That value — `1.0.<minutes>`, which the override
 /// above does set — is the opaque value Tauri's updater compares; it lands in bundle
-/// filenames and `latest.json` and must never be shown to a person (#3144). Two
-/// values, two audiences. `update.rs` deliberately still reads the key, through
-/// `app.package_info().version`, because a comparator is exactly what it is.
+/// filenames and `latest.json` and must never be shown to a person. Two values, two
+/// audiences. `update.rs` reads the key, through `app.package_info().version`,
+/// because a comparator is exactly what it is.
 const DISPLAY_VERSION: Option<&str> = option_env!("INKWELL_DISPLAY_VERSION");
 
 /// The baked build, or the honest "I cannot say". The only way in — the const is
@@ -49,9 +46,8 @@ pub(crate) fn display_version() -> &'static str {
 }
 
 // The store and the sync engine live in the shared `inkwell-core` crate, which
-// the Android client binds through uniffi (Scribe note 2730). Aliased to their old
-// names so every call site below reads exactly as it did when they were modules of
-// this crate — the extraction changed where they live, not what they are.
+// the Android client binds through uniffi. Aliased to short names so the call
+// sites below read as if they were modules of this crate.
 use inkwell_core::{local, sync};
 
 /// The app's own window, as `tauri.conf.json` names it. The capture window is the
@@ -91,7 +87,7 @@ pub fn run() {
                 ])
                 .build(),
         )
-        // In-app updates (M10.9). Registering the plugin is inert on its own — it
+        // In-app updates. Registering the plugin is inert on its own — it
         // reads its config only when `update_check`/`update_install` ask it to, so a
         // build without a signing key still starts normally and simply reports that
         // updates aren't configured.
@@ -102,8 +98,8 @@ pub fn run() {
         .plugin(tauri_plugin_global_shortcut::Builder::new().build())
         // System notifications for due reminders, raised by the `reminders` worker.
         .plugin(tauri_plugin_notification::init())
-        // Attachment bytes are served to the webview from the local blob store
-        // (M10.7f). Registered on the BUILDER because a scheme has to exist before
+        // Attachment bytes are served to the webview from the local blob store.
+        // Registered on the BUILDER because a scheme has to exist before
         // the webview is created; the directory it reads from arrives later, in
         // `setup`, via `blobs::publish_root`.
         .register_uri_scheme_protocol(sync::blobs::BLOB_SCHEME, |_ctx, request| {
@@ -143,9 +139,9 @@ pub fn run() {
             let db = local::open(&db_path)?;
             log::info!("local store ready — {}", local::summary(&db));
             // Before anything can ask what channel we're on: the installer left a note
-            // in this directory saying which one the user picked (issue 2183).
+            // in this directory saying which one the user picked.
             update::adopt_installer_channel(&db, &dir);
-            // And which server, when it installed from one (milestone 325 step 6).
+            // And which server, when it installed from one.
             update::adopt_installer_server(&db, &dir);
             sweep_local_trash(&db);
             // Before the store is handed to the app: `restore` needs to read the
@@ -153,7 +149,7 @@ pub fn run() {
             capture::restore(app.handle(), &db);
             app.manage(db);
             // Attachment bytes live beside the database, filed by content hash, so a
-            // synced image is readable with no network (M10.7d).
+            // synced image is readable with no network.
             let blobs = sync::blobs::BlobStore::new(dir.join(local::BLOBS_DIR))?;
             log::info!("attachment store ready: {}", blobs.root().display());
             // Hand the directory to the URI-scheme handler registered below, which

desktop/src-tauri/src/reminders.rs

@@ -1,10 +1,10 @@
-//! Reminders reach you when the window isn't in front (#5171).
+//! Reminders reach you when the window isn't in front.
 //!
 //! The shared frontend's reminder check is a 45-second timer in the page, which
-//! raises a toast and, if allowed, a page `Notification`. Inside this app that was
-//! not enough. The page's timer only does anything while the webview is running
-//! it, and WebKitGTK's page notifications go nowhere. So a reminder that came due
-//! while Inkwell sat minimised or behind another window was never announced.
+//! raises a toast and, if allowed, a page `Notification`. Inside this app the page's
+//! timer runs only while the webview is running it, and WebKitGTK's page
+//! notifications go nowhere, so on its own it misses a reminder that comes due while
+//! Inkwell sits minimised or behind another window.
 //!
 //! This worker owns announcing on the desktop instead. Every [`TICK`] it asks the
 //! local store which reminders have come due, and announces each occurrence once:

desktop/src-tauri/src/update.rs

@@ -1,22 +1,17 @@
-//! In-app updates (M10.9).
+//! In-app updates.
 //!
 //! Two channels, because two audiences: `stable` follows every merge to `main`,
 //! `dev` follows every green push to `dev`. Each reads a `latest.json` published as
 //! an asset on a release whose TAG NEVER CHANGES — verified necessary, because
-//! Forgejo has no `/releases/latest/download/<asset>` route (it 404s), so "newest"
-//! cannot be named in a URL. A fixed tag can.
-//!
-//! `stable` followed tagged `v*` releases until M314 step 3, and its manifest pointed
-//! at bundles living on a different release. It holds its own bundles now, exactly as
-//! `dev` always has — so a build reaches stable users with no tag cut anywhere, which
-//! is the whole point of the change. NOTHING HERE MOVED: this code only ever read
-//! `<channel>/latest.json`, and that is still where the manifest lands.
+//! the forge has no `/releases/latest/download/<asset>` route (it 404s), so "newest"
+//! cannot be named in a URL. A fixed tag can. Each channel's release holds its own
+//! bundles, so a build reaches stable users with no tag cut anywhere.
 //!
 //! The feed is Fabled-Git by default, deliberately: this app is usable having never
 //! linked a server, and an install that can't reach its own updates because it isn't
 //! paired with anything would contradict the whole local-first premise.
 //!
-//! An Inkwell server can be the feed instead (milestone 325 step 6) — the one a
+//! An Inkwell server can be the feed instead — the one a
 //! self-hoster installed from, whose forge they may have no access to. That reads
 //! alarming until you notice what does NOT move: the server hands out the same
 //! signed AppImage, and the updater checks it against the public key baked into
@@ -24,8 +19,8 @@
 //! can pass on official builds; it cannot substitute its own.
 //!
 //! Updates are signed. The public half is baked into `tauri.conf.json`; the private
-//! half exists only as a CI secret, and is generated by the operator — a release
-//! signing key that has passed through anyone else's hands is not a signing key.
+//! half exists only as a CI secret — a release signing key that has passed through
+//! other hands is not a signing key.
 
 use std::path::Path;
 
@@ -107,10 +102,10 @@ impl Channel {
 
     /// The release tag holding this channel's builds — not the channel's name.
     ///
-    /// `dev` used to be both, and a tag named `dev` shadowed the branch of the same
-    /// name, so `git push origin dev` failed as ambiguous (Scribe #2184). The channel
-    /// is still `dev` everywhere a person sees it and in the stored pref; only the tag
-    /// moved. Mirrors `packaging/channel-tag.sh`, which is what CI publishes with.
+    /// A tag named `dev` would shadow the branch of the same name and make
+    /// `git push origin dev` ambiguous, so the dev channel publishes on `dev-rolling`.
+    /// The channel is `dev` everywhere a person sees it and in the stored pref.
+    /// Mirrors `packaging/channel-tag.sh`, which is what CI publishes with.
     fn release_tag(self) -> &'static str {
         match self {
             Channel::Stable => "stable",
@@ -127,8 +122,8 @@ impl Channel {
 ///
 /// `read_source` is THE ONE READER. Three things hold an opinion about this — the
 /// installer's marker files, this app's prefs, and `plugins.updater.endpoints` in
-/// `tauri.conf.json` — and issues 2181–2183 were each one decision with several
-/// holders and only one of them set. So: the markers only ever feed the prefs
+/// `tauri.conf.json` — and one decision with several holders goes wrong as soon as
+/// only one of them is set. So: the markers only ever feed the prefs
 /// (`adopt_installer_*`), the prefs are what is read, and the config's endpoint is
 /// never consulted, because every check below names its own.
 #[derive(Debug, Clone, PartialEq, Eq)]
@@ -200,7 +195,7 @@ const NOT_AN_ADDRESS: &str =
     "That isn't a server address. It should look like https://notes.example.com.";
 
 /// A server that answered with no AppImage. Never "up to date": the app would sit
-/// on its build forever believing it current, which is #2183's shape again.
+/// on its build forever believing it current.
 fn no_server_build(base: &str) -> String {
     format!(
         "{base} has no desktop build to update from. Ask whoever runs it, or switch \
@@ -256,16 +251,15 @@ fn self_update_blocker() -> Option<String> {
 /// adopted. Called once at startup, before the frontend can ask what the channel is.
 ///
 /// The installer knows which channel the user asked for; the app is what acts on it.
-/// Until this existed, `install.sh --channel dev` left the pref at its `stable`
-/// default, so a dev build checked the stable feed — which advertises an OLDER
-/// version — and reported "up to date" forever (issue 2183). Two places held the same
-/// decision and only one of them was set.
+/// Without this, `install.sh --channel dev` would leave the pref at its `stable`
+/// default, and a dev build would check the stable feed, which advertises an OLDER
+/// version, and report "up to date" forever.
 ///
 /// Comparing against the last-adopted value, rather than only seeding when the pref is
 /// unset, is what makes both directions work: choosing a channel in the app sticks
 /// across launches (the marker hasn't changed since we adopted it), while re-running
-/// the installer on a DIFFERENT channel is honoured (it has). Seeding-when-unset would
-/// have fixed only the very first install and left the second one silently wrong.
+/// the installer on a DIFFERENT channel is honoured (it has). Seeding only when unset
+/// would honour the first install and silently ignore the second.
 ///
 /// Every failure is logged and stepped over. No marker at all is the ordinary state of
 /// a build installed some other way — from source, from a downloaded AppImage, or by a
@@ -552,9 +546,8 @@ mod tests {
     }
 
     /// A scratch path nothing else will collide with. Process id keeps concurrent
-    /// `cargo test` runs apart, the counter keeps tests within one run apart — which
-    /// is all uuid was doing here, without the dependency (the core owns uuid now,
-    /// and pulling it into the desktop crate for two test filenames would be silly).
+    /// `cargo test` runs apart, the counter keeps tests within one run apart — without
+    /// a uuid dependency for two test filenames.
     fn scratch_path(tag: &str) -> std::path::PathBuf {
         static SEQ: AtomicU32 = AtomicU32::new(0);
         let n = SEQ.fetch_add(1, Ordering::Relaxed);
@@ -613,7 +606,7 @@ mod tests {
 
     #[test]
     fn reinstalling_on_a_different_channel_moves_the_app() {
-        // The half a seed-only-when-unset fix would have missed: install stable, then
+        // The case seeding only when unset would miss: install stable, then
         // install dev. The pref is already set, but the user just asked for dev.
         let db = db();
         adopt_installer_channel(&db, &data_dir_with_marker("stable"));
@@ -649,7 +642,7 @@ mod tests {
     #[test]
     fn no_channel_feed_is_named_like_a_branch() {
         // A release tag spelled like a branch makes `git push origin <branch>`
-        // ambiguous once the tag is fetched (Scribe #2184). `dev` and `main` are the
+        // ambiguous once the tag is fetched. `dev` and `main` are the
         // branches this repo pushes.
         for channel in [Channel::Stable, Channel::Dev] {
             assert!(
@@ -718,7 +711,7 @@ mod tests {
 
     #[test]
     fn with_no_server_recorded_updates_come_from_the_forge() {
-        // The operator's own installs: nothing here may change for them.
+        // An install that never came from a server keeps the forge feed it always had.
         let db = db();
         assert_eq!(read_source(&db), Ok(Source::Forge(Channel::Stable)));
         set_channel(&db, Channel::Dev);