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

"Useful Concepts" / Glossary UI improvements #99

Open
terichadbourne opened this issue Dec 7, 2018 · 1 comment
Open

"Useful Concepts" / Glossary UI improvements #99

terichadbourne opened this issue Dec 7, 2018 · 1 comment
Labels
enhancement New feature or request

Comments

@terichadbourne
Copy link
Member

In user testing, @meiqimichelle didn't love the placement of the "Useful Concepts" box, and felt that the information there (in this case definitions of CID and DAG) would be better suited to a glossary format where the user controls what information is displayed, or whether it's displayed at all.

She shared an example of a glossary at https://revenuedata.doi.gov/how-it-works/federal-reforms/ where the user picks what words they want defined in a sidebar, and can then also search for additional terms there.

Although I like the glossary idea, I also think we should introduce some of these "useful concepts" in the lessons themselves. For example, in Basics Lesson 1 I recently changed the lesson content to include a very basic CID explanation that fit the context in which it was being used:

You can create a new node by passing a data object into the ipfs.dag.put method, which returns a Content Identifier (CID) for the newly created node.

ipfs.dag.put({hello: 'world'})

A CID is an address for a block of data in IPFS that is derived from its content. Every time someone puts the same {hello: 'world'} data into IPFS, they'll get back an identical CID to the one you got. If they put in {hell0: 'w0rld'} instead, the CID will be different.

Some of this will be alleviated by the new workshop @mikeal is building around decentralized data structures, which we may be able to link to in order to explain concepts like CID or DAG in more detail.

@terichadbourne
Copy link
Member Author

Noting also this issue for IPFS docs to add hover options for glossary: ipfs/ipfs-docs#294

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant