Bacalhau Documentation Update: Enhanced Collaboration and Navigation
5 Days of Bacalhau (02:54)
We’ve listened to your feedback and are excited to share that our Bacalhau documentation has been completely revamped to better serve our community. This update is all about making our documentation more user-friendly and collaborative.
With improved navigation, real-time feedback, and the opportunity for everyone to contribute, our documentation is now more accessible and user-friendly. We believe in the power of our community, and we’re opening up documentation contributions to everyone. Your insights and contributions can help make Bacalhau not just the best distributed computing platform, but also the easiest to understand and use.
Join us in this journey to make Bacalhau better together. Dive into the new documentation and see how you can contribute.
Key Features of the New Documentation
In our latest update, we focused on three main areas to provide a seamless and engaging experience for all Bacalhau users:
Enhanced User Engagement
Site Ratings: You can now rate each page of the documentation. This feature allows you to provide instant feedback, helping us understand what’s helpful and what needs improvement. Your input is crucial as we strive to make our resources better.
Quick Links: We've added quick links to frequently accessed sections, making navigation faster and easier. Whether you’re looking for a specific API reference, a tutorial, or troubleshooting tips, you can now get there with just one click.
Seamless Collaboration
Direct GitHub Edits: Our documentation is now directly editable in GitHub. This allows community collaboration, letting users suggest edits, add new information, or correct inaccuracies on the spot. This ensures our documentation is always up-to-date and comprehensive.
Contribution Guidelines: To help new contributors get started, we’ve included clear guidelines on how to contribute. No matter your experience level, you’ll find it easy to make meaningful contributions.
Improved Usability
Intuitive Layout: The revamped documentation features a clean, intuitive layout that enhances readability and reduces the time spent searching for information. The new design is responsive, ensuring a great experience on desktop, tablet, or mobile device.
Search Functionality: We’ve improved the search functionality to deliver more accurate results, with relevant suggestions appearing as you type.
Pinned Versions: As Bacalhau evolves, features and functionality change. We recognize that users may be on different versions at different times. To support this, we’ve introduced pinned versions of our documentation starting from version 1.3.0. This ensures you always have access to the information relevant to your specific version.
But Wait, There’s More!
If you enjoy writing technical content about distributed computing, our Contributor Programme is perfect for you. Work directly with our team, create valuable content, and receive rewards for your contributions.
If you’re interested but don’t have much experience writing technical content, contributing to our docs is a great way to start. We’ll support you every step of the way.
Join Us on Our Journey
At Bacalhau, we’re committed to continually improving and evolving our platform to meet your needs. We’re excited about these updates and look forward to hearing your feedback. Dive into the new documentation , explore the features, and let us know what you think. Together, we can make Bacalhau the best it can be.
How to Get Involved
We welcome your involvement in Bacalhau. There are many ways to contribute, and we’d love to hear from you. Please reach out to us at any of the following locations.
Commercial Support
While Bacalhau is open-source software, the Bacalhau binaries go through the security, verification, and signing build process lovingly crafted by Expanso. You can read more about the difference between open-source Bacalhau and commercially supported Bacalhau in our FAQ. If you would like to use our pre-built binaries and receive commercial support, please contact us!
