About Bonadocs
Bonadocs is a comprehensive Web3 developer toolkit focused on simplifying how smart contracts are documented, tested, and integrated. By offering tools like Docgen, Widgets, and a collaborative Playground, Bonadocs enables engineering teams to deliver production-ready dApps with enhanced clarity and efficiency.
Whether you’re a protocol developer, devrel engineer, or frontend integrator, Bonadocs equips you with everything needed to build and share fully interactive documentation, embed smart contract interfaces, and streamline collaboration between Solidity and frontend teams. It’s the essential toolkit for creating seamless smart contract developer experiences.
Bonadocs is a developer-first platform designed to eliminate friction in smart contract documentation and integration. As the Web3 ecosystem grows, protocols and dApps are becoming more complex. Yet, many teams still rely on fragmented or manual documentation workflows, slowing down developer onboarding and limiting community contributions. Bonadocs solves this with a tightly integrated toolkit built specifically for Web3 engineers.
At the center of the platform is Docgen, a CLI-based tool that extracts smart contract documentation and auto-generates interactive websites using Docusaurus. Unlike generic generators, Bonadocs Docgen supports live contract interaction via embedded widgets, enabling real-time testing directly within the docs—no more copying ABIs or switching to Etherscan. Teams can include deployment addresses, configure themes, and ship stunning, dev-ready portals in minutes.
Another core feature is the Bonadocs Widget system, which creates UI components to interact with deployed contracts in real time. These widgets simulate transactions (without gas costs) and can be embedded within docs or frontend applications, making them perfect for devrel teams and protocol onboarding. It's a game-changer for protocols that want their docs to be not only readable, but usable.
The Playground brings together Solidity and frontend developers in a shared environment. This enables cross-team collaboration, prototyping, and contract testing in a single workspace. Whether you’re building an in-house app or open-sourcing a dApp stack, the Playground acts as a collaborative Web3 workspace.
Finally, the Protocol Registry allows developers to explore and interact with a growing list of protocols and their verified contract deployments. It standardizes discovery and interaction across EVM-compatible networks, offering a one-stop directory for developers looking to explore, fork, or integrate with other smart contract ecosystems.
Unlike generalized doc tools like Docsify or Docusaurus, Bonadocs is purpose-built for Web3. It's already supporting leading protocols and is becoming the go-to tool for teams focused on improving developer experience in Web3. From hackathon teams to protocol-level engineering orgs, Bonadocs is changing the way smart contracts are documented, tested, and shared.
Bonadocs provides powerful benefits and features tailored for smart contract development and integration:
- Instant Interactive Documentation: Generate complete, interactive documentation websites directly from Solidity codebases using Docgen.
- Embedded Contract Widgets: Let users simulate and call smart contract methods directly from docs or apps—no gas fees, no external tools.
- Collaborative Playground: Share a live, unified workspace for Solidity and frontend teams to build, test, and integrate together.
- Protocol Registry: Explore and interact with verified smart contracts across EVM chains in one searchable interface.
- Open Source Compatibility: Docs are built on popular static site generators like Docusaurus, with markdown customization support via Handlebars.
- DevRel Friendly: Ideal for developer relations teams that want to reduce onboarding time, improve demos, and showcase contract capabilities interactively.
- Gas-Free Simulations: Built-in simulation mode allows testing of contract interactions without writing manual scripts or spending ETH.
Getting started with Bonadocs is straightforward and highly flexible for Web3 teams looking to build, document, and scale fast:
-
Install Docgen: In your Solidity project, run
npm i @bonadocs/docgento install the CLI tool. -
Configure Hardhat: Import Docgen into your
hardhat.config.tsfile and define your project name, description, output directory, and any deployed contract addresses. -
Generate Your Docs: Run
npx hardhat docgento auto-generate markdown files and a Docusaurus-powered documentation site. -
Preview the Site: Navigate to the generated
docsfolder and useyarn startto preview your live documentation. - Add Widgets (Optional): Include contract deployment addresses in your config to generate live-interaction widgets within your docs.
- Embed & Share: Host your site on any static host (like Netlify) or embed the widgets in your dApp frontend to extend functionality to your users.
- Explore the Playground: Use the collaborative environment to test, simulate, and co-develop smart contract logic with your team.
Bonadocs FAQ
Bonadocs dramatically reduces the time it takes for developers to understand and integrate with your protocol. Through features like Docgen and Widgets, engineers can access interactive documentation that not only explains your smart contracts but lets them test functions in real time—without writing a single line of code. This means fewer questions, faster integrations, and a smoother path from reading to building. Learn more at bonadocs.com.
Yes. One of Bonadocs’ standout features is the ability to embed interactive widgets into your documentation. These widgets allow users to call contract functions, test inputs, and simulate outputs—directly from the documentation site. Powered by
@bonadocs/widget, these tools make learning and testing gas-free and seamless. Check it out at bonadocs.com.Bonadocs isn’t just another static doc generator—it’s a full-stack developer experience platform. While tools like solidity-docgen generate Markdown, Bonadocs builds an interactive website, complete with widgets for live contract interaction, a registry of deployed protocols, and a collaborative playground. It’s built specifically for Web3 teams and goes far beyond what static tools provide. Explore more at bonadocs.com.
Bonadocs supports Docusaurus out of the box but is flexible enough to work with any static site generator. If you prefer VuePress, MkDocs, or Jekyll, you can disable site generation and output only Markdown files. The system is fully configurable through Handlebars templates, allowing you to tailor output to your site’s requirements. Learn how to configure it at bonadocs.com.
Absolutely. Bonadocs is a dream tool for DevRel and protocol teams. By combining documentation and live contract interaction in one place, it eliminates common onboarding issues, cuts down on support tickets, and empowers users to self-serve. Whether it’s internal tooling or public dev docs, your team saves time while delivering a better developer experience. Get started at bonadocs.com.