Working with the documentation

This site documents the intended Prochain AI DJ platform. To begin software work, follow the first implementation slice. See the local startup guide for the sibling daemon and UI.

Run the site

Use Node.js 22 and the package manager pinned in package.json:

corepack pnpm install --frozen-lockfile
corepack pnpm start

Open the local URL printed by Docusaurus. To verify and preview production output:

corepack pnpm typecheck
corepack pnpm build
corepack pnpm serve

Set SITE_URL to the eventual deployment origin when building for hosting. The default is localhost; this repository does not assume a production domain.

Contribute

Edit reference pages in docs/ and walkthroughs in guides/. Add new reference pages to sidebars.js. Use relative .md links within a docs section, and route links across docs plugins. Broken links fail the production build.

Label software behavior as planned until implementation and validation exist. Research claims require a dated source or a reproducible fixture. Hardware claims require model, firmware, operating mode, and evidence. Keep hypothetical scores and benchmark targets clearly separate from measurements.

Write an RFC for unresolved contracts and an ADR for accepted consequential decisions. Keep the roadmap and implementation status aligned when software ships.