The following is a high-level overview of the steps involved when contributing documentation to Buz.
Developing via fork
The Buz documentation site is built with Docusaurus so you'll need yarn and node and that's pretty much it.
Fork the documentation
Clone your fork
git clone email@example.com:silverton-io/buz-docs.git
cding into the
buz-docs directory you just cloned, run:
Run docs site locally
To build (and auto-reload) the docs site:
Cut PR from your fork back into buz-docs
If you don't see movement on your newly-created PR please ping one of the maintainers (nicely 😉).
Deploying Buz documentation
The docs site is auto-deployed using Github Actions. It will be automatically built and deployed after changes are merged to
Where to go next
- Pick up an issue from github and cut your first PR.
- Deploy Buz to a production environment.
- Play around with the Buz documentation.
- Read about the general philosophy of Buz.