Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TASK] Make docs more beginner friendly #93

Open
Tracked by #573
1xstj opened this issue Apr 13, 2023 · 0 comments
Open
Tracked by #573

[TASK] Make docs more beginner friendly #93

1xstj opened this issue Apr 13, 2023 · 0 comments
Assignees

Comments

@1xstj
Copy link
Contributor

1xstj commented Apr 13, 2023

The documentation is well-structured and covers the components of their solution in a clear way (https://docs.webb.tools/docs/). However, my constructive feedback around the documentation is that bridging and privacy are one of the most complex topics in the industry, and the documentation lacks a more introductory part to help the end user understand the big picture of the product offering and its benefits. Some of these aspects are covered in the manifesto, but even with my developer (not privacy-oriented) profile, I struggled initially to understand the product offering. Therefore, I recommend starting the documentation with some basic examples or analogies to help users build their mental model of how the product works.

From tangle-network/dkg-substrate#569

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Completed ✅
Development

No branches or pull requests

2 participants