Getting started · Learning Editor

Install Learning Editor, make your profile, see your first marks and ask the coach for a closer read.

Before you start#

Obsidian 1.13.1 or later, on a computer. Learning Editor doesn't run on mobile.
Model Hub, with one provider set up. The coach runs through it. If you haven't set it up, follow Model Hub's Getting started first.
What it costs. Learning Editor is free. The habit checks, spelling and grammar run on this computer and cost nothing. A coach run is billed by your provider, and stops at Spending limit per run, US$1 unless you change it.

Install#

Open Settings → Community plugins and select Browse.
Search for Learning Editor, then select Install and Enable.

The panel opens in the right sidebar beside the first note you open. To open it any time, select the spell-check icon in the left ribbon.

Make your profile#

Your profile is an ordinary note about your voice and habits. Every check reads it first, so what you keep is never marked.

In the panel, open Rules and profile and select Create your profile.
The note Learning Editor/profile.md opens with a starter profile. Keep what fits, delete what doesn't, and add your own words in quotes.

The starter has five sections: Voice to keep, Never fix, House conventions, Habits to coach and Rejected suggestions.

Already keep a profile? Select Import profile from a file… and type its path. More in Create your profile.

Check a note#

The local checks mark your habits, close repeats, long and sticky sentences, and spelling and grammar. They run only on notes you ask about.

Open a note with a few paragraphs of prose.
Select Check this note in the panel, or run Learning Editor: Check this note.

Words to cut are struck through, a doubled word too, and a long sentence is underlined. The strip at the foot of the note counts the marks by kind.

Once you've checked a note, it's checked again when you open it and 1.5 seconds after you stop typing. To turn that off, switch off Keep checked notes up to date in Settings.

Apply or dismiss a mark#

Each mark has a card that says what to change and why.

Hover a mark, or put the cursor in it and run Show finding, to open its card.
Select Apply to take the fix. One undo takes it back, and the mark comes back too.
Or select Dismiss, then say why: Voice, Wrong or Not now (keys 1, 2 and 3), or Skip.

Your reasons feed what Learning Editor learns. Voice twice on the same words, and it offers to keep them.

A dismissed mark stays dismissed. No check marks the same words for the same kind again. A mark whose words you've edited since turns gray and won't apply, so a fix never lands in the wrong place.

Ask the coach#

The coach is a model that reads the whole draft against your profile, through Model Hub. It runs only when you ask.

Open Settings → Learning Editor. Under Coach, Model should say Model Hub found, followed by its API version.
Select Choose the coach’s model. Model Hub's settings open at the coach's role, which runs on the Careful tier unless you pick another.
Open a note and select Coach in the panel, or run Learning Editor: Coach this note.

Your note leaves this computer here. A coach run sends the note's text, your profile and a count of your habit words to Model Hub, which sends them to the provider you chose for the coach. Nothing else from your vault goes with them, and nothing is sent at any other time. See Privacy and costs.

What you should see#

The status bar follows the run, with its spend against the limit. To stop it, select Stop coaching in the panel or click the status bar. When it ends, a notice says how many places the coach marked and its score, and the marks join the others.

A run stops at its limit or after 8 steps; a stopped run saves nothing.

Try it: coach a short post you know well, dismiss two marks with a reason, and check the cost of the run in Model Hub's usage view.

If it didn't work#

Learning Editor needs Model Hub. Install and enable Model Hub from Community plugins, and add a provider in it.
The coach reached its budget before handing in findings. Raise Spending limit per run, or pick a cheaper model for the coach in Model Hub.
No spelling or grammar marks. Check that Spelling and grammar is on in Settings and that Mechanics isn't hidden.

Every message and its fix: Troubleshooting.