dox docs

dox docs

dox is a web workspace: one Node process serves a page, and that page is the IDE. Windows float on an infinite canvas, every app is a folder, and AI conversations are files rather than a sidebar.

The codebase is four layers — apps, event wires, the canvas, the server — and this documentation follows the same split.

Where to start

  • Install — run it from source, or use a release build.
  • Keyboard — every binding on the canvas and in a window.
  • Apps — what each of the six apps does.
  • Sessions — the .sss file format.
  • Deploy — put it on a server, reach it safely.
  • Architecture — why the four layers exist and what each one owns.
  • manifest.json — the contract for adding an app.
  • HTTP API — every route, including the streaming format.
  • Event SDK — how apps talk without knowing each other.

How these docs are built

Every page is a Markdown file under docs/, compiled into site/docs/ by docs/build.mjs:

npm --prefix docs install   # once
node docs/build.mjs         # writes site/docs/*.html

No framework, no client-side router. The output is static HTML with one stylesheet, so it can be hosted anywhere the site can.