This repository manages the documentation for the Bacalhau Project. This repo also contains the build scripts and tools to create and contribute to the Bacalhau docs website. Explore the docs →
Follow these simple example steps to get a local version of the site up and running.
- Git (Installation instructions), for version control.
- Node.js and
npm(Installation instructions), to run the static site generator Docusaurus used to build this website.
git clone https://github.com/bacalhau-project/docs.bacalhau.org.git
cd docs.bacalhau.org/
npm install
npm run start
The rendered site will be accessible at http://localhost:3000/
docs/ : This is where all the .md files live that control the content of this site. Most contributions happen in this directory.
Note: All code examples live in a dedicated repository https://github.com/bacalhau-project/examples and they are automagically rendered into the ./docs/examples/ folder by github actions.
We would love ❤️ your help to improve existing items or make new ones even better!
If you find any inconsistencies in the docs, please raise an issue here →. Feel free to also submit a pull request with any changes you'd like to see to this repo. Every contribution is more than welcome! 🎈
If you have any questions you can join our Slack Community go to #bacalhau channel - its open to anyone!