ipfs-inactive/docs

Design a glossary of IPFS-related terms

ericronne opened this issue · 8 comments

Here are some design options for a glossary feature, for discussion.

A - Simple pop-up

glossary-A

B - Sliding panel

glossary-B

Toggle visibility with nav button …

glossary-B-button-action

Or tab

glossary-tab

Related issues

Define and implement tagging taxonomy for beta-site content
Create concepts dictionary (meta-concept-doc) aka glossary

My design is based on this code by 18F.

Live example

@ericronne My personal favorite might just be the pop-ups (particularly considering mobile), but kind of want to leave this choice in @cwaring's hands vis-a-vis ease of implementation. They've all got their strengths, so I might be inclined to go with the simplest one to build.

The 18f code is mobile friendly out of the box (not sure about vue-friendliness). +1 to @cwaring's call, 🙌
foLaM0rrNB

If this is being built in VuePress, any chance it can be built to be compatible with Vue as well so it can be used on ProtoSchool? See this open issue: ProtoSchool/protoschool.github.io#99

I do love this idea but it could be an entire product by itself. As @terichadbourne pointed out the real value might come from a plugin that could work on any of our websites/apps. If we are considering i18n too it does start to get quite complex so we'll have to draft out the scope or MVP for testing on the docs site first.

I would exclude the glossary from the beta launch and bump it to next q as an enhancement.

+1 - I think that was actually always the idea.

Closing this issue in favor of already-existing #56, and linking in #56 to this discussion so we can implement visuals when we start work on this project.