Skip to content

Latest commit

 

History

History
79 lines (61 loc) · 3.18 KB

v0.1.0.md

File metadata and controls

79 lines (61 loc) · 3.18 KB

v0.1.0 Release Notes

First public pre-release.

What StudyLoop is

StudyLoop is a local-first, AuDHD-aware study companion. It combines live Socratic mentoring, Body Double sessions, study plans, spaced review, and a searchable record of real learning sessions.

Version 0.1.0 is intentionally pre-1.0: the learner experience is usable, but installation and public interfaces may still change as real users try it.

Mentor harnesses

The core pre-release contract is:

  • Kiro CLI, which is also used for the public demo;
  • Codex;
  • Claude Code.

OpenCode and pi are included as preview integrations. Their install, launch, resume, export, doctor, automated-test, and live-turn results are tracked in release evidence rather than asserted from static prose.

Each harness writes its own real conversation into the shared session database. StudyLoop does not create generated-looking placeholder conversations or progress rows when a harness, exporter, or extraction model fails.

What works

  • Study Session: an energy-aware Socratic mentor in the browser or terminal.
  • Body Double: one visible goal, a timer, and a quiet agent workspace.
  • Review: flashcards, quizzes, teach-backs, weak-link views, and spaced repetition.
  • Study plans: local plan documents, milestones, evidence, and checkpoints.
  • Session memory: exports from the five admitted harnesses into SQLite, with optional Obsidian mirroring.
  • Content generation: validated flashcard, quiz, and practice artefacts from live local or cloud model providers.

Honest limitations

  • Installation is from a source checkout; there is no PyPI or Homebrew release.
  • The Web UI requires the local studyloop web service and is built for laptop and tablet layouts. Phone widths get a usable bottom tab bar rather than a broken one, but a phone is not a supported layout and no journey is tested at that size.
  • Practice-task generation and verification are currently CLI workflows.
  • An agent-led planning interview is not integrated into the Web UI yet.
  • Two headline journeys have no automated end-to-end coverage, because both need a live agent or model provider that CI does not have: the Socratic study conversation itself, and generate-then-review for flashcards and quizzes. Each is exercised by hand. Everything else in the browser workspace runs on every change; the current pass count is in the release-gate evidence (just release-check), not copied here, so this note can never go stale on that number.
  • Live struggle extraction requires an explicitly selected Bedrock model and fails closed when the model or credentials are unavailable.
  • Automated verification and manual learner-journey acceptance are recorded as separate release evidence.

Install

git clone https://github.com/NetDevAutomate/StudyLoop studyloop
cd studyloop
./scripts/install.sh
studyloop setup
studyloop doctor --fix

Then run studyloop web and follow docs/first-week.md.

Verification

Run just release-check for the current automated release gate and just docs for the strict public-documentation build. The release decision should cite the generated evidence from the run, never a test total copied into this note.