{"sections":[{"markdown":"# The briefing server\n\nWhat an agent is handed before it starts. Ask for the part you need: a briefing is sections, and each route answers with the sections it names.\n\n## Routes\n\n- `GET /` - this page - what the routes are, and what each one answers\n- `GET /health` - an empty object, and nothing else; no token needed\n- `GET /purs` - the PureScript briefing - the house's sections, then the lint rules it checks\n- `GET /ts` - the TypeScript briefing - its sections, none written yet\n- `GET /org` - how the organisation works, whatever the language - repositories, policies, review\n- `GET /everything` - every section there is\n- `GET /purs/api` - the PureScript API: every package, ours or a dependency, with its size\n- `GET /purs/api/signatures.md` - every module of ours with its signatures, dependencies by module name - read first\n- `GET /purs/api/module/<Module.Name>.md` - one module in full: signatures, doc comments, instances\n- `GET /purs/api/package/<package>.md` - one package's modules in full\n\n## Asking\n\nEvery route but `/` and `/health` needs the token, as a bearer. Without one the answer is 401, and a path that names no briefing is 404.\n\n`curl -H \"Authorization: Bearer $BRIEFING_TOKEN\" https://briefing.mbock.space/purs`\n\n## What comes back\n\nAn object with `at`, the milliseconds when the briefing was gathered rather than when it was asked for, and `sections`, each with an `about` naming it and a `markdown` holding it.","about":"the briefing server"}],"at":1795258220258}