docs.mru.space

Documentation for Mru's open core: the shrinking-quorum runtime (mruspace/flight), the Dusk simulator (mruspace/dusk) and Mru 2049 (mruspace/2049).

Questions: Get in touch or contact@mru.space.

Build

Needs Node 22.12 or later.

npm ci
npm run dev        # http://localhost:4321
npm run build      # static site in dist/, then the Pagefind search index
npm run check      # every check CI runs

The site is static HTML built with Astro. Search is Pagefind, built into dist/pagefind/ after the site. Without JavaScript, the search field submits a site search to DuckDuckGo instead.

Layout

src/pages/          one file per page; routes follow the folders
src/components/     top bar, navigation, "On this page", page ending
src/data/           navigation order, page metadata (titles, descriptions)
src/styles/docs.css rules that only the docs need
src/styles/shared/  copied from mruspace/website; never edit here
scripts/            sync-tokens.mjs and the checks
public/             fonts (copied), favicons, CNAME

Shared design system

mruspace/website is the only source of the stylesheet, fonts and shared components. Copy them with:

npm run sync-tokens            # from ../website if checked out, else GitHub

CI runs node scripts/sync-tokens.mjs --check against the website's main branch and fails if any copy differs.

Writing docs

When the docs and the code disagree, the code is right. Each page names its source file at the end. Keep sentences short, give every number its source and scope, and state limits next to the claim.

Deployment

Merges to main publish to docs.mru.space with GitHub Pages, by the workflow in .github/workflows/. public/CNAME pins the domain.

License

• Code: Apache License 2.0.
• Documentation text: CC BY 4.0.
• Fonts in public/fonts/: SIL Open Font License 1.1 (license files alongside).
• The Mru name and logo are trademarks of Binns Pte. Ltd. and are not covered by these licenses. See TRADEMARK.md.

© Binns Pte. Ltd.