aweft

Documentation

The guides read in order, then one page per package, per recipe and per component, and the spec. Every page here is also served as markdown at its URL with .md on the end, and /llms.txt lists them all.

Guides

  • Start: Install two packages, render a page, boot a server, then put the two in one directory. Each step is a program you can run, and each one is the first half of something the recipes finish.

  • The three ideas: Everything in the stack sits on three ideas. A reader who holds them can predict what a package does before reading its README, and a reader who does not will find every package surprising in the same way.

  • Building with aweft: The rules an application holds, and the loop for a page. Read start first; this is what comes after the scaffold.

  • Translation: A page is written once, in one language, and launched in as many as it needs. The build finds every string, an agent or a person fills a catalog per language, and the site writes one tree of pages per language. Nothing in the page changes between one language and three.

  • Security: The stack's security standard is the OWASP Application Security Verification Standard (ASVS), version 5.0, at level 2, the way its components hold to WCAG 2.2 AA. This file says what that claim means, what the stack owns, what an application built on it still owns, and the rules that keep the second list short.

  • Deploying: One Node process is the whole deployment: it serves the pages the build wrote and answers the health check a deploy polls. This is how this site is deployed, and it is one shape among several; the stack decides none of it.

The rest

  • Packages: one page per package, its README with the API, the refusals and the recipes that prove it

  • Recipes: whole programs by the task you arrived with, every file readable

  • Components: every component @aweftjs/ui ships, live in both modes, with its source

  • The spec: the wire format, the id scheme and the replication protocol