Documentation (EPIC)

[0xjona]

We need to discuss together what kind of documentation we need to develop and why.
After this brainstorming phase, we’ll have to breakdown this issue into further steps.

As for the issues we were having, do we still need

• video guides to explain the product or give public updates (blog posts, presentations)
• public documentation wiki, built using gitbook or similar OSS
• convert notion documentation to a lite paper
• write down the read me how to run the demo (github /install)

In this issue me and @irenegia will define the deliverables, which will be planned accordingly (e.g. writing down the lite paper assigned to irene and design a visual guide outsourced to graphic designer)

UPDATE

• NEWS / BLOG #37
• /install readme “how-to-run” the demo #38
• LITEPAPER #39
• Homepage COPY #40

[0xjona]

@irenegia should we set a call? Who else should be involved?

[irenegia]

@0xjona
I believe we can briefly discuss this in the next weekly call as the list you wrote is basically already complete.
Just few comments:

video guides to explain the product or give public updates (blog posts, presentations)

I would reduce the scope of this: 1 blog post and 1 video (demo of 5 minutes)
(tbd timing and topics)
(team)

write down the read me how to run the demo (github /install)

perfect! Example: see installation and usage section here
https://github.com/drand/drand#installation
(assigned @turinglabsorg and @0xjona)

convert notion documentation to a lite paper

perfect! (assigned @irenegia )

public documentation wiki, built using gitbook or similar OSS

since we have the lite paper with a complete description of the protocol (theory part) and we have the 'read me' as installation guide (practical part), I suggest to remove this.
We just need some simple text explain the protocol at high level to fill the web site, once we have it.

[0xjona]

we need the "about"

• website copy

[0xjona]

We just need a little improvement in website homepage copy (will come after internal feedbacks and brainstorm) and work on the #37 for #62