← Files BodhiKitARCHIVED FILE
skills/notes-setup/SKILL.md
6.73 KB · Nov 21, 2026 · 12:41 UTC
--- name: notes-setup description: "Keep a syllabus of each course, with when your reviews are due, and your revision sheets in the notes app you already use, or as a file in each course folder. Turn it on, change it, or turn it off." --- ## OpenAI runtime Before using state, a knowledge base, a role procedure, or another BodhiKit skill, read the [OpenAI runtime adapter](../../references/openai-runtime.md). Its local-state and conversation-only modes are mandatory compatibility rules. # `notes-setup` skill — Your Notes, Where You Already Keep Them You are BodhiKit. Reference the `teaching-personality` KB for voice. **Knowledge bases are packaged references.** A `` `name` KB `` named anywhere in this file lives at `<BODHIKIT_PLUGIN_ROOT>/references/knowledge/name.md` — read it when the phase that references it begins, not before (progressive disclosure). This is a setting, not a lesson. It decides whether BodhiKit keeps, for each course, a syllabus (the plan, where the learner stands, and when reviews are due) and the revision sheets in one more place the learner already looks: their notes app, or a file in each course folder. It is off until the learner turns it on. The learning folder stays the record: the notes app only ever holds a copy, and nothing is read back from it. Every write goes through `bodhi-state`; never edit a notes file by hand. The commands are listed in `references/notes-file.md` in this skill's directory (`<BODHIKIT_PLUGIN_ROOT>/skills/notes-setup/references/notes-file.md`); read it only for the Fallback. In what the learner reads, describe what happens in plain words: never name a command, an output key or a file of BodhiKit's own. --- ## Phase 1: Where Things Stand Find the learning folder, first match wins: the working folder if it is a course or the folder that holds the courses; a `learningWithBodhi` folder inside the working folder; `~/learningWithBodhi`. Then run: ``` "<BODHIKIT_PLUGIN_ROOT>/scripts/bodhi-state" --project <learning folder or a course> notes-show ``` - `profileFound: false` → there is no learning folder yet. Say that notes are kept for courses BodhiKit tracks, and that `learn` skill starts one. Stop. - `appsOffered` is empty → notes cannot be kept on this host yet (a chat with no folder of the learner's to write to). Say so in one or two sentences, record nothing, and stop. - `choice` is `vault`, `files` or `off` → Phase 4. - `choice` is null → Phase 2. If `request input` is `off`, say notes are not on, so there is nothing to turn off, and stop. ## Phase 2: Ask Which Notes App Ask one question, offering exactly these answers: - each app in `appsOffered`, by its `name`; - "I don't use a notes app"; - "Just keep the syllabus as a file in each course folder" (files only, no app). Then: - **An app from the list** → Phase 3 with that app. - **Files only** → Phase 3 with files only. - **An app not on the list** (Notion, OneNote, Apple Notes…) → say plainly that BodhiKit cannot write to it yet. Offer files only, or an app from the list. - **"I don't use one"** → suggest exactly one app, the first in `appsOffered`, and say why in a sentence. For Obsidian: it is free, it keeps every note as a plain file in a folder on their own computer, so BodhiKit can put the syllabus and sheets there directly and the notes stay theirs. Ask whether they would like that (they install it and create a vault, then come back) or files only for now. Suggest no other app. ## Phase 3: Say What Happens, Then Agree **For an app** (`location: folder`), ask for the vault's folder: the folder they chose when they created the vault. Ask; don't look for one on their computer. Before anything is recorded, tell the learner in plain words: 1. **What is copied**: each course's syllabus (the plan, where they stand, when reviews are due), refreshed at the end of each study session, and the revision sheets they already get. 2. **Where it goes**: a folder named `Learn with Bodhi` inside their vault, one folder per course, and a page listing the courses. Nothing else in the vault is touched, and nothing written there comes back into their record. 3. **Sync**: if their notes app syncs that vault (Obsidian Sync, iCloud, another service), the copy travels wherever the vault syncs. 4. **It is optional**, and they can change it or turn it off at any time with `notes-setup` skill. Turning it off deletes nothing. Then ask: "Shall I set it up?" Record nothing until they say yes. If they name a different folder or app instead, that is a new choice, not a yes: say where the copy will now go and ask again. On yes: ``` "<BODHIKIT_PLUGIN_ROOT>/scripts/bodhi-state" --project <learning folder> notes-set --choice vault --app <app> --location "<vault folder>" ``` **For files only**, say the same four things for the files: a syllabus file at the top of each course folder, rewritten at the end of each study session; nothing leaves the computer; optional; off at any time. On yes: ``` "<BODHIKIT_PLUGIN_ROOT>/scripts/bodhi-state" --project <learning folder> notes-set --choice files ``` **Then report from the command's output, and only from it.** - **It refused** (an error, nothing recorded): say why in plain words. The folder does not exist; or it is inside the learning folder; or it holds the learning folder, in which case the notes app already shows those files and files only is the better choice. Ask for another folder, or offer files only. - **It worked**: name the folder where the notes now are (`home`) and the courses that arrived there (`sync.firstArrival`). Say a course is saved there only if it is listed. If `sync.failed` lists anything, say which course or file did not copy, and why. - **Close**: from now on this happens by itself at the end of each study session. ## Phase 4: Change It or Turn It Off Show the current setting in one or two plain sentences: the app and its vault folder, files only, or off, and since when (`agreedOn`). Offer: change the app or the folder (→ Phase 2), switch to files only (→ Phase 3), turn it off, turn it back on (→ Phase 2), or leave it as it is. With `request input` `off`, go straight to turning it off. **Turning it off**: confirm, then run: ``` "<BODHIKIT_PLUGIN_ROOT>/scripts/bodhi-state" --project <learning folder> notes-set --choice off ``` Then tell the learner that the syllabus and sheets already written stay where they are, in the vault and in the course folders, and that they will no longer be refreshed. Nothing was deleted. They can turn it back on with `notes-setup` skill. --- **Fallback:** if `bodhi-state` cannot run here, record nothing and edit no file by hand. Tell the learner that keeping notes needs BodhiKit's state script, which could not run in this session, and that nothing was changed. `references/notes-file.md` describes the setting, for explaining what it would hold.
SHA-256: 3f477dbaf4a76ad0fa33617f5e6370e3e5cd6f3f4363ae6969d1c3b2f8c71420