From b9b6ab5e1fe533a3ad8d85e34df44a7118aae3b9 Mon Sep 17 00:00:00 2001 From: Michael Vawter Date: Tue, 6 Oct 2026 00:09:10 -0400 Subject: [PATCH] docs: README matches main after Phase 0 The scripts line now lists lint, lint:fix and test:e2e. The Development section names the ESLint config and describes the pre-commit hook as it runs since #94: Markdown lint plus ESLint with --fix on staged files, with type-checking in CI (ADR 0002). Settings opens from the System panel at the top right, not the taskbar, and the Agent Chat opens with the desktop. Closes #124. Co-Authored-By: Claude Opus 5.5 --- README.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a5e6862..c42debd 100644 --- a/README.md +++ b/README.md @@ -98,28 +98,35 @@ npm install npm run dev # Nuxt dev server, default http://localhost:3000 ``` -Open **Settings** from the taskbar and paste an API key for your model -provider. The key stays in your browser and travels per request; the -server never stores it (ADR 0005). Then open the Agent Chat and -describe an app: it is written, compiled in the browser, installed -to the taskbar, and kept across reloads. +Open **Settings** from the System panel (top right) and paste an API +key for your model provider. The key stays in your browser and +travels per request; the server never stores it (ADR 0005). Then +describe an app in the Agent Chat, which opens with the desktop: it +is written, compiled in the browser, installed to the taskbar, and +kept across reloads. -Other scripts: `npm run build`, `npm run typecheck`, `npm run lint:md`. +Other scripts: `npm run build`, `npm run typecheck`, `npm run lint` +(`npm run lint:fix` applies fixes), `npm run lint:md`, and +`npm run test:e2e` (see [tests/e2e/README.md](tests/e2e/README.md)). ## Development -Markdown is linted with markdownlint-cli2 (80-column prose) and -carries OKF frontmatter. +Code is linted with ESLint (`eslint.config.mjs`), including a rule +against imports between feature slices (ADR 0001). Markdown is +linted with markdownlint-cli2 (80-column prose) and carries OKF +frontmatter. Node 24 LTS is the standard runtime — see [ADR 0011](docs/adrs/0011-node-24-lts-runtime-standard.md); `nvm use` picks it up from the checked-in `.nvmrc`. ```bash npm install +npm run lint npm run lint:md ``` -A pre-commit hook runs the lint automatically; write with the +A pre-commit hook lints the Markdown and runs ESLint with `--fix` on +staged files; type-checking runs in CI (ADR 0002). Write with the conventions in [docs/agents/use-okf.md](docs/agents/use-okf.md) and [docs/adrs/template.md](docs/adrs/template.md).