ipld/explore.ipld.io

Add explanatory info/context to IPLD Explorer

Open

#55 opened on Mar 24, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (34 forks)auto 404
P1effort/weeksexp/intermediategood first issuehelp wantedkind/enhancementstatus/readytopic/design-contenttopic/design-front-endtopic/design-uxtopic/design-visual

Repository metrics

Stars
 (133 stars)
PR merge metrics
 (PR metrics pending)

Description

This issue is one of the prioritized recommendations in the Q1 2020 IPFS Ecosystem Audit for execution in Q2/Q3 2020. Tagging it with $auditrecommendation means it's searchable! See all tagged issues in this repo.

IPLD Explorer is awesome once you know what all of it means ... but that's making a massive assumption. We're missing out on a large learning opportunity.

Add explanatory info and context to the site, so someone inexperienced in IPFS could use this as an entry point to learning more in general. This could include ...

  • Inroductory content provided in a non-intrusive way, so it could ignored by those in the know
  • Hover links with extensive cross-linking to docs, ProtoSchool, etc

Also see https://github.com/ipfs-shipyard/ipfs-companion/issues/610 for additional brainstorming on better integrating IPLD Explorer.

Contributor guide

Research direction
Explore the current IPLD Explorer site to understand its UI components. Identify where explanatory tooltips or hover links could be added. Look at existing documentation sources like ProtoSchool and ipfs docs to plan cross linking. Consider using CSS for non intrusive tooltips and JavaScript for dynamic hover interactions. Test your changes on a local development instance.
Tech stack
javascript
Domain
frontend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
HTMLCSSJavaScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85