- VitePress for the static site generator
- Cloudflare Pages for hosting (project:
prova-docs) - GitHub Actions builds + deploys on every push to
main
.
├── 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
npm install
npm run dev # http://localhost:5173Hot reload as you edit markdown.
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.
- Find the file in the repo (the URL maps directly:
docs.prova.network/api/upload→api/upload.md) - Edit, commit, push to
main - GitHub Actions builds + deploys within ~1 minute
- 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.
- 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/:::dangercontainers for callouts- One H1 per page, matching the page's
descriptionfrontmatter
Apache-2.0 OR MIT. See LICENSE.