Commit 43faaf7
docs: critical review pass on README + CLAUDE.md for 2.0.1-beta
README.md
---------
- §"What this plugin deliberately doesn't do": fixed two outright
contradictions. Removed "no branches / no merge commits / one
linear history per repo" (false — pseudo-merge mode creates a
per-device conflict branch + finalize merge-commit). Removed
"no automatic conflict resolution that could lose data" (auto-
merge IS automatic; the honest statement is "no silent overwrites
on a true conflict — binary + overlapping text always surface").
- §"How it stacks up" comparison: strengthened the github-easy-sync
row's "Best for" cell to surface the conflict-UX differentiator;
added a callout paragraph below the table contrasting our
sibling-file approach vs other plugins' inherited git marker
workflow (which degrades on mobile, on long-form previewed notes,
on binaries).
- §"What's new in 2.0.1-beta": pruned to one-liners pointing at the
full §"Conflict resolution" section below for mechanics. The
marketing-list / detail-section split is now cleaner.
- §"What this plugin does well": added a one-line cross-ref from
"Resume on crash" to §"What's new" so users learn about the
crash-tolerant atomic-write protocols without us echoing the
same bullet twice.
- §"Migrating from another sync plugin": added a one-paragraph note
that genuine divergences during adoption surface as sibling
files — without this the migrating user might assume the sibling
is an error.
- §"Bonus: cloning plugins": added a callout that plugin data.json
conflicts use the same pseudo-merge model (no special handling).
- §"Settings reference": section already rewritten per current
tab.ts layout (Interface section added; "Sync configs" + "Push
plugins data.json" merged under Sync; reset behaviour + sibling
rename documented; "Removed in 2.0.1-beta" subsection lists
commit-template field, custom-message commands, settings-tab
pending-conflicts list).
- §"Common gotchas" troubleshooting: added two entries — "where
did my sibling file go after I resolved" (it became the base on
rename) and "*.unresolved-* files lying around" (leftovers from
a previous Reset).
- §"Device label": fixed casing in the commit-message example
(`Sync` → `sync`) to match the actual hardcoded format.
- §"Polling, not events": clarified that vault listeners ARE
attached, just read-only for counter refresh.
CLAUDE.md
---------
- Added three Constraints bullets the rewrite had pruned too
aggressively: no scheduler logic in main.ts (IntervalScheduler
owns it); drain() re-entrant-safe via running flag (don't
bypass); commit messages are hardcoded (don't reintroduce a
template field).
Tests still 526/526 GREEN; build clean.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent d2eb482 commit 43faaf7
2 files changed
Lines changed: 198 additions & 111 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
166 | 166 | | |
167 | 167 | | |
168 | 168 | | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
169 | 172 | | |
0 commit comments