Prova

Appearance

Prova

Prova Docs

Source for docs.prova.network. VitePress, deployed on Cloudflare Pages.

livesitelicense

Stack ​

  • VitePress for the static site generator
  • Cloudflare Pages for hosting (project: prova-docs)
  • GitHub Actions builds + deploys on every push to main

Structure ​

.
├── index.md                      home page (hero + feature cards)
├── SUMMARY.md                    table of contents
├── getting-started/              quickstart paths
│   ├── web-upload.md
│   ├── cli.md
│   └── quickstart.md
├── concepts/                     architecture, piece-cids, deal lifecycle, …
├── api/                          full HTTP API reference
├── cli/                          `prova` subcommand reference
├── sdk/                          TypeScript SDK reference
├── provers/                      operator-facing pages
├── reference/                    glossary, errors, changelog
├── public/                       static assets (logo, favicon, downloads)
└── .vitepress/
    └── config.mts                site config, nav, sidebar

Local dev ​

bash
npm install
npm run dev          # http://localhost:5173

Hot reload as you edit markdown.

Build ​

bash
npm run build
# output → .vitepress/dist/

The deploy workflow (.github/workflows/deploy.yml) runs this on every push to main and ships the build directory to Cloudflare Pages.

Edit a page ​

  1. Find the file in the repo (the URL maps directly: docs.prova.network/api/upload → api/upload.md)
  2. Edit, commit, push to main
  3. GitHub Actions builds + deploys within ~1 minute
  4. Refresh the live site

You can also click "Edit this page on GitHub" at the bottom of any docs page to jump straight into the editor.

Conventions ​

  • Frontmatter: description: is required for every page (used in meta tags + search). icon: is GitBook-only and stripped at build time.
  • Link to other docs pages with relative paths: [Architecture](../concepts/architecture.md)
  • Code blocks: tag the language so syntax highlighting works
  • Tables for API parameters, status codes, environment variables
  • :::tip / :::warning / :::danger containers for callouts
  • One H1 per page, matching the page's description frontmatter

License ​

Apache-2.0 OR MIT. See LICENSE.

Apache-2.0 OR MIT.

© 2026 Prova