Skip to content

Commit 9d5b8db

Browse files
InfantLabclaude
andcommitted
docs(roadmap): API and CLI from a launcher install; shorten INSTALLATION.md
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 595c60f commit 9d5b8db

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

‎docs/development/roadmap_v1.6.0.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -576,6 +576,22 @@ job in the wizard from memory, although every job already stores its `selected_p
576576
installed pipelines restored after recreation, Settings' Stop sharing); open: the CI
577577
end-to-end runs with Docker and Podman (first run on a push to `master`), the quickstart
578578
walkthroughs on Linux and Windows, and a pilot researcher on macOS (T082-T084).
579+
- [ ] **The API and CLI from a launcher install** (found 2026-10-16): a researcher started with
580+
`videoannotator-start` has no `videoannotator` command on the host, and the API key it
581+
made sits in `start.conf`, which no command prints. Phase 3's R and Python notebooks and
582+
Phase 4's MCP server both need the URL and key. Proposal: `videoannotator-start api`
583+
prints the URL, the key and a three-line R, Python and curl example, and
584+
`videoannotator-start cli ARGS` runs the CLI inside the container with the key already
585+
set. Docs that say `docker compose exec videoannotator va ...` (`accessing_results.md`,
586+
`demo_commands.md`) move to whatever this settles on.
587+
- [ ] **`INSTALLATION.md` down to the researcher's install** (2026-10-16: 729 lines): it opens
588+
with the launcher and then runs through the developer uv install, a manual OpenFace 3
589+
build that the `face-openface3` extra replaced, Docker Compose, the dev container, a
590+
second troubleshooting section, an architecture overview and performance tips. Keep the
591+
launcher steps, sharing, GPU, Ollama, system requirements and where results go. Move the
592+
uv install and dev container to a developer page linked from `CONTRIBUTING.md`, Docker
593+
Compose to its own page, troubleshooting into `troubleshooting.md`, and drop the manual
594+
OpenFace build.
579595

580596
**Not in this phase**: a visual redesign. Decide on one after the pilot, from what outside users
581597
say.

0 commit comments

Comments
 (0)