This folder contains docs for Rill, generated using Docusaurus and deployed to https://docs.rilldata.com.

npm install

To start the docs server with hot reloading, run the following command from the root/docs folder of the repo:

npm run dev

To run a full build and production preview of the docs, run the following commands from the root/docs folder of the repo:

npm run build
npm run preview

The docs site is deployed via Netlify.

The CLI reference docs in docs/reference/cli are auto-generated based on the CLI help text. To re-generate the docs, run the following command from the repository root:

make docs.generate

Sometimes you want to merge documentation but hide it pending a future release, there are a few different short-hands available.
For individual pages add sidebar_class_name: hidden to the top of the page and to hide an entire category add className: hidden to the _category_.yml file. Note that the pages are only hidden but still generated so you can still link to them.