Documentation Revamp

Documentation revamp

Tailored for your needs - Developers, Node Operators and the Community

At Dusk, we believe that the key to revolutionizing finance not only lies in cutting-edge technology, but also in providing the resources our community needs to use that technology effectively. As we move closer towards our mainnet launch, we are thrilled to share the comprehensive revamp of our documentation with you. This update is not just a small refresh, it is designed specifically with developers, node operators and the broader community in mind, with the goal of making it easy to build on and participate in the Dusk blockchain. 

>>Read the documentation here<<

Streamlined for every type of user

Our new documentation structure is all about getting you the information you need faster, with less fluff. We’ve moved away from deeply nested menus to a more straightforward role-oriented structure:

  • Learn: This section is created for the general community and crypto enthusiasts. It covers everything from basic knowledge about blockchain to advanced architectural topics, zero-knowledge and cryptographic primitives, which can be found in our Deep Dive section.
  • Developer: For those building on the Dusk network, this section is meant to be focused and concise. Whether you’re developing smart contracts or working on integrations, this section will directly take you to the relevant topic for your work.
  • Node Operator: Looking to run a Dusk node? This section is dedicated to helping you set up and manage your node, whether you prefer to build from source, use a Docker image or connect with our testnet. We also explain the different node types in the Dusk ecosystem and their system requirements.

A Deep Dive into Developer docs

One of the biggest updates to our documentation is the developer section. Here’s how we’ve structured the content:

  • Smart Contracts: This is the core of our developer resources, covering everything you need to build, deploy and manage smart contracts on our network. We provide detailed guides on how to write your first contract, compiling and more.
  • Integrations: Whether you’re working on exchange integration, connecting with our wallet stack, or integrating with Dusk contracts, this section will provide you with the information you need. 
  • Digital Identity: Focused on our Citadel identity solution, this section includes everything you need to work with the protocol and integrate it using our SDK.
  • Dusk Improvement Proposals (DIPs): DIPs are for community-driven proposals, with guidelines on how to submit and implement your ideas.

A Better User Experience

In addition to content improvements, we’ve made a number of improvements to the docs user experience. Each page now features a table of contents for easier navigation. Every page now has previous and next buttons to navigate between articles. We’ve improved the readability of headers, and the mobile experience is now more user-friendly. The new structure and extra navigational aids make the documentation easier to use.

Why It Matters

For those who are part of the Dusk community, or are considering joining, documentation is one of the first things you’ll see. First impressions matter. By making our documentation more accessible and role-specific, we’re making sure the community, developers and node operators can easily find what they need.

Check out the new documentation today at docs.dusk.network and let us know what you think!