Contents
Technical documentation and content is a key driver for the success of our developers and developer community. Good documentation simplifies the development process, enabling developers to quickly and easily perform business operations and tasks. Bad documentation, on the other hand, can lead to confusion, mistrust, and a general lack of clarity on how to perform tasks and actions. Hiro is constantly striving to provide best-in-class technical content for our community, whether it is continual content updates and new feature content; or improving the overall documentation experience when visiting the Hiro documentation site.
With this in mind, we would like to talk about some significant improvements and changes we made recently to the documentation site, which we hope will make for a more pleasant and engaging experience.
Navigation Redesign
The Hiro documentation site has been redesigned to make it easier for you to navigate and discover content. Navigation and site design are key components in the documentation experience, and we wanted to redesign our content so you can find product-specific information quickly and easily. Here’s what we changed:
Our technical content is now separated into different sections, organized by product:
- Clarinet
- Explorer
- Stacks Blockchain API
- Stacks.js
In each of those sections, you will find the following subsections:
- Overview
- Getting Started
- Feature Guides
- How-to Guides
- Developer Resources
This new organization should make it much easier for you to learn all about our products and reduce the need for you to click on multiple pages to find what you are looking for.
Content Discoverability
With the changes made to the left sidebar navigation, you are able to locate content based on a specific product more easily. This includes blog posts, YouTube videos, and deep dives into specific features and workflows for each individual product, and other resources that exist outside of documentation itself.
Content Clarity
We also performed a content overhaul, rewriting product documentation where needed, and reordered the content to mirror the actual onboarding process you will follow when using one of our products. For example, if you look at the Clarinet documentation in the How-To Guides section, you will now see a detailed breakdown of each step in the entire Clarinet contract deployment process; beginning with Set Up a Local Development Environment all the way to Deploy Contracts.
By simplifying and easing the onboarding process, you should be able to quickly learn about our products, gain deep technical knowledge, and then use what you have learned in your own work.
Conclusion
We hope you find these new changes helpful, and we are continuing to roll out new improvements. Check out our redesigned documentation below, and if you have feedback on how to improve, please leave us a GitHub issue or pull request here.
