docs: add onboarding documentation#93
Conversation
…rations, desktop-electron, docs index) - Add docs/getting-started.md with four self-contained install paths: desktop app, GPU server, mock mode, and contribute - Add docs/environment.md with ~50 env vars across 8 concern groups - Add docs/operations.md covering setup, deployment, daemon mode, remote deploy, desktop app, health checks, and troubleshooting - Add docs/desktop-electron.md for Electron build/install/dev workflow - Add docs/README.md as a top-level docs index - Fix README.md: stale v1.13.0 release notes replaced with CHANGELOG link, wrong Docker command fixed to match docker-compose.yml, add getting-started link to Docs and Setup guide sections All six cross-referenced doc links now resolve — zero dead links.
- Replace <repo-url> placeholders with actual repo URL - Fix GPU server path: add VLLM_STUDIO_HOST=0.0.0.0 for remote access - Rewrite desktop-electron.md Quick Start with first-time guidance - Add [Back to docs index] nav links to all four docs
|
Thanks — this fills a real gap (it also directly resolves #104) and the structure holds up well against the current tree. Since you wrote it, the project was renamed to Local Studio: every |
2 participants
Hey — I noticed a few gaps that make it harder than it should be for someone new to get running, so I put together some docs to help.
The gaps
The README linked to three docs that didn't exist yet — `docs/README.md`, `docs/operations.md`, `docs/environment.md`. The frontend README also pointed at a missing `docs/desktop-electron.md`. And the Docker quick-start command referenced `controller` and `frontend` services that aren't in `docker-compose.yml` (only `postgres` lives there).
Most importantly, there was no obvious entry point — a desktop user had to read through GPU server setup to find their path, and someone without a GPU didn't know mock mode existed.
What I added
Where to look first
`docs/getting-started.md` is the entry point — if that reads right, the rest should land.
All six cross-referenced doc links now resolve. The `docker-compose.yml` mismatch in the README is fixed. No code was touched, so lint/typecheck/test pass as before.
I kept this scoped to onboarding — recipe/model setup docs felt like the natural next step, but I wanted to get this in front of you first rather than bury you in one giant PR. Happy to adjust anything that doesn't match the voice or structure you want.