Skip to content

Repository files navigation

Wuzzy Docs

The documentation site for Wuzzy, served at docs.wuzzy.io. Built with rspress and deployed statically to Cloudflare Pages.

What belongs here

The narrative layer: the quickstart, how to verify a result, how to commission an index, and a consumer-facing API reference.

The protocol artifacts themselves live in the main repository and are canonical there, because they sit beside the code that has to keep them true:

  • VERIFY.md specifies the canonicalization procedure, with conformance vectors.
  • SCHEMA.md specifies the onchain attestation schema and how to decode one.
  • apps/backend/README.md is the operator-facing API reference, covering configuration and the admin surface as well.

Pages here link to those rather than restating them. Duplicating a specification is how two sources drift, and only one of them can be the one the tests check.

Setup

npm install
npm run dev       # dev server
npm run build     # static build into doc_build/
npm run preview   # serve the production build

Deploying

operations/ holds the Nomad job specs, and deploys are run by hand from a machine that can reach the mb-hel cluster. CI builds and publishes the image; it does not deploy.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages