ReviewOS

also looking at this

stacks/uplink

docs: the documentation the README points at

#63
Merged glennmichael123 wants to merge docs/the-missing-docs into main
9 files +509 -10
README.mdmodified+10-6
Changes to README.md
@@ -145,7 +145,7 @@ Pushing to `main` deploys https://uplink.stacksjs.com once CI passes (`.github/w
145145| `./buddy uplink:ask "<prompt>"` | Run one prompt exactly as a text would, without Messages |
146146| `./buddy uplink:release` | Build, sign and notarize Uplink.app and publish it to GitHub Releases |
147147| `./buddy uplink:watch` | The watcher itself, in the foreground (needs Full Disk Access for your terminal) |
148| `./buddy dev` | The dashboard: setup status, what it is doing, recent texts |
148| `./buddy dev` | Serves the dashboard at https://uplink.localhost/dashboard and the docs at /docs. Both are local only: the dashboard answers 404 in production |
149149
150150Configuration lives in `.env`; see the `UPLINK_*` block in `.env.example`, which covers both
151151engines (`UPLINK_ENGINE`, `UPLINK_CLAUDE_BIN`, `UPLINK_CODEX_BIN` and the rest). The service picks
@@ -159,11 +159,15 @@ up edits by itself.
159159 `codex-engine.ts`, `engines.ts`), replies (`sender.ts`, `format.ts`), the launchd service and app
160160 bundle (`service.ts`, `launcher.ts`) and setup checks (`doctor.ts`).
161161- `app/Commands/Uplink.ts`: the `buddy uplink:*` commands.
162- `app/Models/`: `Conversation` (a thread, its agent session and which agent) and `Run` (one text,
163 one run).
164- `resources/views/index.stx`: the dashboard.
165- `tests/unit/uplink/`: against a real chat.db-shaped SQLite file and stub CLIs.
162- `app/Models/`: `Conversation` (a thread, its agent session and which agent), `Run` (one text, one
163 run) and `License` (a key, its plan and its Stripe ids).
164- `app/Billing/`: Stripe Checkout, licences and the plans they come from.
165- `resources/views/index.stx`: the public page at https://uplink.stacksjs.com.
166- `resources/views/dashboard.stx`: the dashboard, local only. It calls `notFound()`, so it answers
167 404 wherever the site is deployed.
168- `docs/`: the documentation, served at /docs by `buddy dev`.
169- `tests/unit/`: against a real chat.db-shaped SQLite file and stub CLIs.
166170
167171```bash
168./pantry/.bin/bun test tests/unit/uplink
172./buddy test
169173```