dusk-network / dusk-network/docs

Visual content ideas for the docs

Open
#27 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

need:feedback type:enhancement
Dominant language
MDX
Stars
8
Forks
4
Avg merge
3h 57m
Merged PRs (30d)
8

Description

We are looking to improve our docs with visually appealing and informative graphics. They should help in explaining complex concepts, processes and features of Dusk. The goal is to make our docs more engaging and easier to understand.

Possible solution design or implementation
This issue can be used to gather suggestions for graphics and diagrams we can make for our docs.

This can include:

  • Conceptual diagrams: Explaining key concepts, such as smart contracts, privacy mechanisms
  • Process flows: Step-by-step diagrams showing technical processes or user journeys
  • Feature highlights: Graphics visualizing our unique selling points, such as compliance tools, identity solutions and privacy features
  • Technical architecture: Diagrams explaining our blockchain components, interactions and flows
  • Infographics: Easy to digest high-level overviews and stats, like key achievements of the network (number of active nodes/stakes/TPS)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by reviewing the existing Dusk documentation and identifying which concepts, processes, features, and architecture need visual explanations; the work is complete when specific graphics are selected and their documentation locations and intended content are defined.

Written by the indexing model from the issue text.

Assessment

Tech stack
blockchain
Domain
blockchain, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.