prumo-site
The public website for Prumo and
Prumo Desktop, published at
prumo.stjosephworks.org.
It was generated by Prumo itself, as a site project, and follows the conventions in .prumo/ like any
other generated project. That is deliberate: a tool whose answer for a public page is Next on the App
Router has no business publishing its own page on anything else.
What the site owns, and what it only renders
Every document has exactly one home.
| Content | Lives in |
|---|
| The getting-started path, the conventions explainer, the command reference, the Desktop page | This repository, in src/app/[lang]/ |
README.md, docs/stack.md, docs/structure.md and the rest | prumo and prumo-desktop, fetched at build |
Nothing in the second row is retyped here. content/documents.json lists each one with the repository, the
path, the commit it is pinned to and the route it becomes; scripts/fetch-docs.mjs downloads exactly those
files into content/fetched/, which is not committed. A file that does not answer fails the build.
The same manifest also reads cli/package.json at that commit, so the version in the footer is the one the
pinned commit publishes rather than a number kept by hand.
Describing a newer Prumo
There are no tags to pin to: releasing the CLI is a version bump landing on main. So the pins are commit
SHAs, raised by editing content/documents.json. That commit is also what redeploys the site, so no webhook
is needed from the other repositories.
Languages
English, Portuguese and Spanish, under /en, /pt and /es. Each language is one entry in
src/features/i18n/locales.ts, with its dictionary in
src/features/i18n/dictionaries/ and its blurb for each document in content/documents.json; the tests walk every
entry, so a new language fails them until all of it is written. Only the pages this repository writes are
translated; the fetched documents are rendered in English in every language with a note saying so, because
translating them would rebuild in other languages the duplication the manifest exists to avoid.
A path without a locale, / included, is answered by src/proxy.ts with a redirect to the visitor's language: the
one picked in the language menu, kept for a year in the locale cookie, else the first one their browser accepts
(pt-PT reaching pt), else English. A path that names a locale is never redirected.
This repository departs from prumo's rule that every file is written in English, and only there:
Portuguese and Spanish are allowed in the translated content. Every identifier, comment and commit message stays
English.
Running it
pnpm install
pnpm dev
The site runs on http://localhost:3200. / redirects to the visitor's language; see Languages.
| Command | What it does |
|---|
pnpm fetch:docs | Downloads the pinned documents. Runs automatically before dev, build, test and typecheck |
pnpm test | Checks the manifest, the dictionaries, and that every search anchor exists in the rendered page |
pnpm lint | Biome |
pnpm typecheck | Next's route types, then tsc --noEmit |
pnpm build · pnpm start | Production build, then serves it |
History
dev-logs/ holds how this site was decided, kept for context and referenced by nothing: not by this README,
not by the manifest, not by a page. Read it to understand why something is the way it is, never to learn
what is in force.
License
MIT
