Joystream / Joystream/jip

Document Portal

Open
#2 3 comments 0 reactions 1 assignee View on GitHub

@DzhideX is already working on this.

Since Feb 21, 2023.

nara-network
Dominant language
No language data
Stars
3
Forks
2
PR merge metrics
No merged PRs in 30d

Description

Background

The JIP repository is the primary destination for collaborating on and publishing JIP documents, however being able to conveniently consume the information in these documents is a distinct purpose, and the JIP Document Portal attempts to serve this objective. It is a collection of webpages which can provide a web experience, powered by the repository and the chain (indexing service), that is very convenient for consumption and discovery of JIP documents. Here are some examples of benefits

  1. HTML version of all documents with generated TOCs.
  2. An index HTML page of all JIPs with key information derives from documents, e.g. stage and owner(s), as well as most recent values for Joystream Process Parameters set by council.
  3. Full links to configurable websites for resolving on-chain links, e.g. some Pioneer or Atlas instances.
  4. Rendering on-chain resources with rich presentation, such as members with full handles and avatars. (would require being online during generation step)
  5. Free-text search and browsing functionality across proposals documents.
  6. Reverse lookup based on members, JIPs, and other identifiers.

In the future perhaps this can be incorporated into Pioneer, but to avoid that extra complexity it's better to keep it separate.

Proposal

Implement a first version of the portal which can present the desired experience to users by scraping the repo and a QN. It's important that the experience is not too slow, so perhaps preloading all JIPs an other relevant content during a loading stage perhaps would increase usability.

Also, defining a more narrower MVP scope than all points above, for example 1+2+3.

┆Issue is synchronized with this Asana task by Unito

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.