Updates Politeia docs #758
Conversation
|
+1 for proposal guidelines page, it will be possible to link it compared to current copy buried in some .js file on github. |
|
Created decred/politeiagui#947 to extract the .md files with the docs. P.S. Such meta planning and discussion shall better happen in an issue, while pull requests are used for concrete implementation steps and link to the meta issue. |
|
@lukebp, nice suggestions. You may want to double check my rewordings for accuracy, but I think we're almost there. Also, while I have your eyeballs, can you check my attempted definition of @xaur, left a comment on that politeiagui Issue regarding the modal copy, |
There was a problem hiding this comment.
Added a few in-line comments, but also one general comment.
This PR adds some new hyperlinks pointing to internal docs pages, and the link text is not capitalised. I think we might want to capitalise them so the formatting of the link text matches the formatting of the page title. I gathered a list as I was going through the PR:
politeia.md
[introduction to Decred governance]
[proposal guidelines]
[example proposals]
[navigating politeia data]
example-proposals.md
[proposal guidelines]
proposal-guidelines.md
[example proposals]
Thoughts about that?
|
@s-ben the text that you updated to address my issues LGTM. |
|
@jholdstock , good catches. Have implemented your suggestions. |
|
Two comments outstanding above. Otherwise everything is looking good to me. |
|
@jholdstock comments addressed. PR moon? |
|
Looks good to me generally, I like the tips for creating a successful proposal. |
|
@RichardRed0x yeah @jholdstock was noticing the ugly too (his comment below for reference). I think it's the best we can do for now, but there's an open issue to address it.
|
Now that we've had Pi running for a while (and have updated copy in the Pi modal), it's time to updated and flesh out the Pi documentation on dcrdocs. This PR: