dcrdocs
dcrdocs copied to clipboard
Simple "how to" guides for critical Politeia use cases
Simple "baby guides" with screenshots and "where to click" instructions for the following use cases might be useful to have:
- how to sign up
- how to create a proposal (with links to guidelines how to create a good one)
- how to vote with CLI
- how to vote with GUI
While I agree with @jholdstock that signing up is fairly self explanatory (yay good UI!), we do need to document these things somewhere. And a "baby guide" at some point seems like a good idea. The structure of proposals however (e.g. required sections and what we call those sections), is still being debated and in flux. Therefore I think the first step might be just documenting the above bullet points in dcrdocs.
I just surveyed dcrdocs, and it appears creating a proposal is loosely documented in the Politeia proposals and voting page; basically this is a less detailed version of the guidelines we give in the 'Learn More About Politeia' modal in Pi. However, I can't seem to find documentation anywhere for how to vote with the CLI or GUI.
The How to Vote page has instructions for voting on consensus changes. But does voting on Pi proposals require different/new commands?
The Using Decreditions page likewise has instructions and screenshots documenting how to vote on consensus rule changes. But do we need to update these for Pi?
Related: do we want to leave instructions for voting on Pi proposals in the same pages as current instructions on voting on consensus rules? Or do we create a separate page (possibly this is a "baby guide") on how to use Pi?
I'm not currently finding the answers to these questions on the READMEs for /politeia or /politeiagui, and attempting to learn by doing is stymied (right now) by there being no proposals being voted on (live or on testnet). Just updated to Decredition 1.3.1, but it's hanging...should have that soon.
P.S. I think something like Dash's 'how to create a good proposal' guide would be useful once we have more data/consensus on what a good proposal is. https://docs.dash.org/en/latest/governance/eight-steps.html
To clarify, "How to create a proposal" and "Guidelines for good proposals" are different things. The former just guides you through the UI, while the latter suggests sections and their content.
@jholdstock made a good point that UI is bad if it is not self-explanatory and requires external visual guides, so I'm unsure about this one. Intuitively I felt it could be useful and filed an issue.
One non standard use is to let new people have a "glance" at how it looks without touching it. You can hear about the thing many times but once you see the screenshots it somehow feels closer and you might thing "ohh this is not as complex! gonna try it". A video guide would fit this purpose too.