@staff0rd/assist 0.886.6 → 0.888.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -40,14 +40,14 @@ After installation, the `assist` command will be available globally. You can als
40
40
 
41
41
  ## User guide
42
42
 
43
- The user guide is a static site built from JSON pages in `docs/guide/pages/` and PNGs in `docs/guide/screenshots/`.
43
+ The user guide is an [Astro Starlight](https://starlight.astro.build/) site in its own `docs/` package, built from markdown pages in `docs/src/content/docs/` and PNGs in `docs/public/screenshots/`. Astro is a dependency of `docs/` only; run `npm run docs:install` once to install it.
44
44
 
45
- - **Add a page** — add `docs/guide/pages/<id>.json` with `id`, `title`, `group` (a nav group from `src/docs/docsPageSchema.ts`), `order`, `covers` and `sections` (`heading`, `markdown`, optional `screenshots`). `covers` lists the inventory ids the page documents (`cli:<command path>`, `claude:<name>`, `config:<key>`, `route:<path>`); delete each one from `src/docs/pendingUserDocumentation.ts`. Unknown keys, unknown ids and missing screenshots fail the build.
45
+ - **Add a page** — add `docs/src/content/docs/<id>.md`. Its YAML frontmatter, validated by `docsPageSchema` in `src/docs/docsPageSchema.ts`, has `id` (the file name), `title`, `group` (a sidebar group from `docsNavGroups`), `order` within the group, `covers` and optional `screenshots`. Each `##` heading starts a section. `covers` lists the inventory ids the page documents (`cli:<command path>`, `claude:<name>`, `config:<key>`, `route:<path>`); delete each one from `src/docs/pendingUserDocumentation.ts`. Unknown keys, unknown ids, unknown scenes and missing screenshots fail the build.
46
46
  - **Coverage report** — `npx tsx src/docs/docsCoverage.ts --report` lists the commands, skills, config keys and routes still pending documentation, by area. `verify:docs-coverage` fails when an item is neither covered nor pending, or is both.
47
- - **Screenshots** — each screenshot declares a `route`, and optionally `viewport` (default 1280×800), `theme`, `waitFor` and `crop` selectors, a `scene` (a named list of setup steps in `docs/guide/capture/scenes.json`), `setup` steps run after the scene, and `actions` (`{ "click": "<selector>" }`, `{ "press": "<key>" }`) performed on the page before capture. Setup steps: `{ "assist": [args] }` runs an assist command in the sandbox, `{ "run": "<name>" }` starts a run session from `docs/guide/capture/assist.yml`, and `{ "session": { repo, prompt, title?, reply?, status? } }` starts an agent session in the `sandbox`, `api` or `website` repo and sets its status (`running`, `waiting` or `done`). The capture puts a fake `claude` (`docs/guide/capture/bin/claude`) on the `PATH`, which prints the step's `reply` lines as its transcript and answers title generation with its `title`, so no real harness runs. Screenshots sharing a scene and setup are captured together, and the sessions are drained before the next state is set up. Without a `theme`, it is captured as `<file>` (light) and `<file>-dark.png`, and the site shows the one matching the reader's colour scheme. A `{{screenshot:<file>}}` line in the section's markdown places the screenshot there; otherwise it follows the section's text.
47
+ - **Screenshots** — each entry in the frontmatter's `screenshots` declares a `file`, `alt` and `route`, and optionally `viewport` (default 1280×800), `theme`, `waitFor` and `crop` selectors, a `scene` (a named list of setup steps in `docs/capture/scenes.json`), `setup` steps run after the scene, and `actions` (`click: <selector>`, `press: <key>`, `type: <text>`) performed on the page before capture. Setup steps: `assist: [args]` runs an assist command in the sandbox, `run: <name>` starts a run session from `docs/capture/assist.yml`, and `session: { repo, prompt, title?, reply?, status? }` starts an agent session in the `sandbox`, `api` or `website` repo and sets its status (`running`, `waiting` or `done`). The capture puts a fake `claude` (`docs/capture/bin/claude`) on the `PATH`, which prints the step's `reply` lines as its transcript and answers title generation with its `title`, so no real harness runs. Screenshots sharing a scene and setup are captured together, and the sessions are drained before the next state is set up. Without a `theme`, it is captured as `<file>` (light) and `<file>-dark.png`, and the site shows the one matching the theme the reader picked. A `::screenshot{file="<file>"}` line in the page places it; a declared screenshot with no such line, or a line naming an undeclared one, fails the build.
48
48
  - **Recapture** — `npm run docs:capture [-- <file.png>...] [--skip-build] [--keep-home]` builds assist, starts a throwaway Postgres container (Docker required), clones `staff0rd/sandbox` (plus local `api` and `website` repos) into a temporary `HOME`, runs the real daemon and web server there on a free port, captures the screenshots with Playwright (`npx playwright install chromium` once) and tears everything down. Commit the changed PNGs.
49
- - **Preview** — `npm run docs:build [-- --base <path>]` renders the site into `.docs-site/`, and `npm run docs:preview` builds and serves it on port 4173, rebuilding and reloading open tabs when a page, screenshot or the stylesheet changes.
50
- - **Feedback** — start the `docs` run entry (a `server: docs` run of `docs:preview` on port 4173) from the dashboard and open the preview in Firefox with the [assist browser extension](#docs-feedback) installed. Select text on a page, press the assist icon next to the selection, type a prompt and press **Enter**: it arrives as a user prompt naming the page id, section heading and source JSON file, with the selected text quoted, in the live Claude session that shares the docs server's directory — the one the run is grouped under on the dashboard. With several such sessions, the one that most recently wrote that page's JSON (else the newest) gets it; with none, the live session that most recently wrote the page or anything under `docs/guide/`.
49
+ - **Preview** — `npm run docs:build` builds the site into `docs/dist/`, and `npm run docs:preview` runs the Astro dev server on port 4173, which reloads open tabs as pages change; a tab with a feedback popover open reloads once the popover closes. Set `DOCS_BASE_PATH=<path>` to build for a site hosted under a sub-path. The sidebar is read from the pages' frontmatter when the server starts, so restart it after changing a page's `group` or `order`.
50
+ - **Feedback** — start the `docs` run entry (a `server: docs` run of `docs:preview` on port 4173) from the dashboard and open the preview in Firefox with the [assist browser extension](#docs-feedback) installed. Select text on a page, press the assist icon next to the selection, type a prompt and press **Enter**: it arrives as a user prompt naming the page id, section heading and source `.md` file, with the selected text quoted, in the live Claude session that shares the docs server's directory — the one the run is grouped under on the dashboard. With several such sessions, the one that most recently wrote that page (else the newest) gets it; with none, the live session that most recently wrote the page or anything under `docs/src/`.
51
51
 
52
52
  ## Claude Commands
53
53
 
@@ -590,7 +590,7 @@ Sending is Firefox-only (it relies on the `browser.*` promise APIs). The web ser
590
590
 
591
591
  ### Docs feedback
592
592
 
593
- `npm run docs:preview` stamps each page with `<meta name="assist-docs-page">` (the page id) and marks each section with `data-docs-heading` and `data-docs-source` (its JSON file); `docs:build` output carries none of these. The `docs.js` content script runs on any `localhost` / `127.0.0.1` page but only activates on one with the page meta. Selecting text inside a section shows a small assist icon by the selection; pressing it opens the same prompt popover, and **Enter** sends a non-empty prompt. The background script POSTs `{ pageId, heading, source, selection, prompt }` to `POST /api/sessions/docs-feedback`, which asks the daemon (`type-prompt-to-writer`) to paste the prompt into the live agent session whose working directory matches a live server run's directory that contains `source`, and submit it. Ties go to the session whose Claude transcript has the newest Write/Edit of `source`, else the newest session; with no such session it falls back to the newest writer of `source`, else of any file under `docs/guide/`. A toast names the session, or reports a 404 when no session qualifies.
593
+ `npm run docs:preview` stamps each page with `<meta name="assist-docs-page">` (the page id) and marks each section with `data-docs-heading` and `data-docs-source` (its `.md` file); `docs:build` output carries none of these. The `docs.js` content script runs on any `localhost` / `127.0.0.1` page but only activates on one with the page meta. Selecting text inside a section shows a small assist icon by the selection; pressing it opens the same prompt popover, and **Enter** sends a non-empty prompt. The background script POSTs `{ pageId, heading, source, selection, prompt }` to `POST /api/sessions/docs-feedback`, which asks the daemon (`type-prompt-to-writer`) to paste the prompt into the live agent session whose working directory matches a live server run's directory that contains `source`, and submit it. Ties go to the session whose Claude transcript has the newest Write/Edit of `source`, else the newest session; with no such session it falls back to the newest writer of `source`, else of any file under `docs/src/`. A toast names the session, or reports a 404 when no session qualifies.
594
594
 
595
595
  ### Permanent Firefox install
596
596