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.

Sign up for GitHub

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

Jump to bottom

Intro text #8

Open
mishmosh opened this issue May 15, 2019 · 0 comments
Open

Intro text #8

mishmosh opened this issue May 15, 2019 · 0 comments
Labels
design-content Content design (writing, info architecture) kind/enhancement A net-new feature or improvement to an existing feature

Comments

@mishmosh
Copy link

I think intro text would help make this even better as a standalone learning experience, in 2 areas:

1. What does this thing do?

It could take a few forms. In order of my personal preference:

  • small section that's visible by default, and doesn't impede usage of visualizer, but can be dismissed via click or scroll
  • in the header, always visible
  • triggered by a help or about link
  • splash screen upon first load

Here's a first pass of the text, interested in comments!

"DAGs (directed acyclic graphics) are the core data structure of IPFS. They enable efficient data verification and management. Upload a file, then click menu options to explore the different ways that file can be split up into chunks."

2. What do these things mean?

The menu options might also benefit from some description. Example below:
dag-visualizer 001
@alanshaw alanshaw added the kind/enhancement A net-new feature or improvement to an existing feature label May 24, 2019
@ericronne ericronne added design design-content Content design (writing, info architecture) and removed design labels May 24, 2019
alanshaw pushed a commit that referenced this issue Jun 13, 2019
feat: add rabin chunker option
e2da4b3 
Also adds some `title` attributes to explain what the different options do. Should help #8

License: MIT
Signed-off-by: Alan Shaw <[email protected]>
@alanshaw alanshaw mentioned this issue Jun 13, 2019
Merged
alanshaw pushed a commit that referenced this issue Jun 26, 2019
feat: add rabin chunker option (#17)
430f648 
Also adds some `title` attributes to explain what the different options do. Should help #8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
design-content Content design (writing, info architecture) kind/enhancement A net-new feature or improvement to an existing feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@alanshaw @mishmosh @ericronne