Announcing Hiro Developer Docs

Type
Announcement
Topic(s)
Hiro
Docs
Published
October 28, 2021
Author(s)
Team
Announcing Hiro Developer Docs
Contents

Product updates & dev resources straight to your inbox

Please enter a valid email address.
Please agree to data privacy and terms of service.
Thanks for subscribing.
Oops! Something went wrong while submitting the form.
Copy link

New Hiro developer documentation

As a developer tools company within the Stacks ecosystem, Hiro is committed to delivering high quality documentation for Stacks developers. To that end, Hiro has moved developer-centric Stacks documentation from docs.stacks.co to a new site at docs.hiro.so.

With Hiro developer docs, you can expect guides for how to use the developer tooling, example applications, API documentation and library documentation specifically for Clarinet, stacks.js, and Stacks API. In the future you might see developer-focused documentation on other Hiro products such as the wallet and explorer.

This effort is a work in progress. We will be working throughout Q4 to ensure that the developer content is up to date, and reflects the current state of developer tools for Stacks.

Contributing to Hiro documentation

The Hiro developer documentation is open-source, and we welcome community contributions. You can find the source for the Hiro documentation on Github. If you would like to contribute, feel free to fork the repo and submit a PR with your changes. If you find an issue but are unable to fix it yourself, submit an issue to the repository so that we can review.
The site is built with Docusaurus, and uses markdown with Docusaurus extensions for content storage. There are several internal style checks that occur at PR time, and links are automatically validated as well. In the near future, we will publish more extensive contribution resources for community members.

State of Stacks ecosystem documentation

Documentation for the broader Stacks ecosystem is vitally important. We encourage the community to take ownership of the documentation located at docs.stacks.co. At Hiro, we plan to continue contributing content to docs.stacks.co as appropriate. The ecosystem docs are important in documenting Clarity, providing technical details of the Stacks blockchain, and assisting new users of the chain in running their own nodes and even participating in mining.
We encourage anyone interested in contributing articles on this topic to check out the ecosystem documentation from its Github repository and start learning how to contribute. Hiro will continue to help review documentation PRs to the ecosystem repository, and we hope to make the handoff to the community as smooth a process as possible.

Stacks documentation residence program

If you are interested in helping take direct ownership of the Stacks ecosystem documentation, the Stacks Foundation is seeking a Documentation Lead through the Stacks Residence Program. You can find out more about the residency process in the Residence Program Github.

Copy link
Hiro news & product updates straight to your inbox
Only relevant communications. We promise we won’t spam.

Related stories