Docs

Every doc lives in the repo. Each link goes to the doc on GitHub. Pages on this site have a Markdown copy: add .md to the address.

Start here

Use it

Build on it

  • Architecture: how a command runs and which XState machines model it.
  • Development: read before you change webular or run its tests.
  • Build and run: run from source, use the bundles, or build the executable.
  • Bug classes: each kind of bug webular can hit, where it shows up, and what guards against it.
  • Mise tasks: every mise task, what it does, and what it runs first.
  • Best practices: each practice webular follows, with its source and check.
  • Research ledger: the papers behind webular’s design choices, and the ranked changes each topic suggests.
  • Research status: how many papers and repos were read, and which ranked changes are applied, rejected, or open.
  • Jev in webular: how to set up the Jev key on any OS, and each route webular takes to Jev for its judgment calls.
  • Docs rules: the rules for writing these pages.