For agents
The machine-readable addresses of this manual, and what to give an assistant that is helping somebody install or deploy this.
This manual is written to be read by a person and fetched by a program. Nothing here is special to one assistant or one vendor: it is plain text at fixed addresses, which is the whole of the convention.
The four addresses
| Address | What it is |
|---|---|
/llms.txt | The index: every page, with the sentence that describes it |
/llms-full.txt | The entire manual in one file, page by page, as Markdown |
/docs/<path>.mdx | One page, as Markdown. /docs/start/install.mdx is the install page |
/sitemap.xml | Every public address on the site |
Start with /llms.txt when nobody knows which page matters, and fetch the single .mdx once they do. The
full file is the expensive one and it is worth it exactly once, for an assistant that has to answer several
questions in a row without coming back.
The prompt that works
Handing an assistant a link and hoping is how a conversation becomes a summary of a web page. This asks for what is actually wanted:
Read this page of the Loomis manual: https://your-domain.com/docs/start/install.mdx
Tell me what it covers, then the exact steps I need to take, in order. Ask me for anything you need
that I have not told you: which machine I am on, whether I already have Node, and whether I have a
Convex account.Every page has a Copy as Markdown button and an Open in ChatGPT and Open in Claude button under its title, which do the same thing without typing an address.
What an assistant needs to understand first
Three facts about this installation are true on every page, and a helper that does not know them will produce advice that does not work:
Two environments, not one. Seven settings are read by the app, which runs on Node, and they belong in
.env.local on the machine that runs it. Twelve are read by the deployment, which is Convex, and they are
set on the deployment with npx convex env set. A value in the wrong one looks set and does nothing.
Two deploys, not one. The backend is pushed with npx convex deploy; the app is built with
pnpm build and started with pnpm start, or handed to a platform that does that for it. They are separate
steps and either can be done first, but the app needs the backend's address.
The product name is not the code's name. The installation is called Loomis in this manual and in the
code. What a buyer calls it is a setting in the panel, under Brand → Branding, and no code change is needed
to rename it.
What the folder contains for a coding agent
An assistant that is working in the code rather than helping somebody install it should read AGENTS.md in
the folder first. It is short, and it says where the conventions of this framework differ from what an
assistant is likely to assume, which is the one thing that otherwise gets re-learned on every task.
The manual ships with the product
These addresses are served by the installation itself, so they are the buyer's own domain from the moment it is deployed. Nothing here calls out to a documentation service, and nothing stops working when somebody else's site does.