Skip to content

0.2.4 — modular docs + per-section help links

Choose a tag to compare

@davadev davadev released this 16 Jun 04:38
· 25 commits to main since this release

New

Documentation (docs/)

  • index — TOC of every guide
  • faq — top issues + where to fix them
  • ollama-tips — model choice (7B vs 14B vs 32B), repair iterations, when to send known words
  • story-generation — what Smart Story does end-to-end, the repair loop
  • srs — how reviews get scheduled and which knobs matter
  • exposure — what counts as 'seeing' a word + dedup rules
  • word-states — new/partial/known/unknown/ignored + marking modes
  • display-modes — two-line, three-line, colors, pinyin styles
  • sync-mirror — vault-side mirror for users who don't sync .obsidian/
  • conflicts — how the priority list resolves two-device disagreements

Settings tab integration

Each settings section (Display, Tokenizer, Exposure, SRS, AI provider, Generated stories, Sync, About) now shows a "Read the guide on GitHub →" link at the top, opening the matching doc in a new tab. No more guessing what a knob does — click through for the deep dive.

Repo tooling

  • npm run check-release — pre-release validator (BRAT artifacts, version sync, mobile-safe imports, fundingUrl hosts, no hardcoded paths, etc.). --with-build runs build + tests; --tag X cross-checks the manifest version.
  • AGENTS.md updated with the new release workflow.

No plugin behavior change. Existing data + settings untouched.