Updates to Documentation #18
Conversation
CHANGELOG.md
Outdated
|
|
||
| ## [0.3.0] - 2018-05-29 | ||
| ### Added | ||
| - --b flag to specify a block integer. This allows user to display records starting with a block number. |
| All pull requests must include: | ||
| * A clear, readable description of the purpose of the PR | ||
| * A clear, readable description of changes | ||
| * A title that includes (Fix), (Feature), or (Refactor) |
There was a problem hiding this comment.
I'm not sure about that; I'm happy to start following that rule, but it doesn't look like other projects (e.g. poa-bridge) are doing this.
There was a problem hiding this comment.
I think it's from here poanetwork/RFC#3
we are trying to add this to a culture 😅
There was a problem hiding this comment.
Thank you! It would be great if we could turn this RFC into a final document, and then link to it from all projects. Otherwise there's a danger that we copy different versions of it into different Readme files.
There was a problem hiding this comment.
If there is group consensus on the PR rule set, I agree we should create as wiki post and link from all repos.
README.md
Outdated
|
|
||
| **Example:** | ||
| ```bash | ||
| $ parity --chain c:\path\to\spec.json --reserved-peers c:\path\to\bootnodes.txt --pruning=archive --no-warp |
There was a problem hiding this comment.
Below we use Unix-style filenames (with / instead of \), and we currently don't provide Windows binaries at all; maybe the example files should be something like poa-chain-spec/spec.json and poa-chain-spec/bootnodes.txt.
README.md
Outdated
|
|
||
| `-v, --verbose` display collected ballot and key change events and the list of participating and abstaining voters for each ballot. | ||
|
|
||
| `-c, --contracts <contracts>` append a map with POA contract addresses in JSON format. The current maps for the main and test network are in the `contracts` folder. Default is the main network `core.json` file. |
There was a problem hiding this comment.
Maybe "a map file". "A map" could be misunderstood: one might read it as a string with the values that is given explicitly on the command line.
README.md
Outdated
|
|
||
| 1. Parity must be fully synced to the correct node and running in full mode, not "light" mode. Check Parity UI and/or Task Manager to confirm Parity is synced and actively connected to peers. | ||
|
|
||
| 2. The correct network must be selected in Parity. The Parity UI will show the current network selection in green. Make sure this is the correct network, and not the Foundation or other Etherium network. |
README.md
Outdated
|
|
||
| 1. Parity must be fully synced to the correct node and running in full mode, not "light" mode. Check Parity UI and/or Task Manager to confirm Parity is synced and actively connected to peers. | ||
|
|
||
| 2. The correct network must be selected in Parity. The Parity UI will show the current network selection in green. Make sure this is the correct network, and not the Foundation or other Etherium network. |
There was a problem hiding this comment.
Here we could also mention again that you need to use a contracts address file (-c option) that matches the network. Included are files for the main POA network ("core") and the POA test network ("sokol"). poa-ballot-stats needs to be run with a file matching the network that the Parity node is connected to.
…iles including updated screenshot change updates fixed typos Documentation Updates Document updates
I added the following: