Skip to content

docs: suggestions/issues from review #2143

@ebuchman

Description

@ebuchman

tendermint.com/docs/

  • all links are broken
  • main page should have a small section for each seection in the sidebar: Getting Started, Core, Tools, Networks, Apps, Research.
  • You should be able to link directly to one of these sections, rather than "the first subsection within them"

Getting Started

  • first subsection is called Tendermint. Should be called Quick Start
    • should link to places to find more advanced starts !

Using Tendermint

  • We should reconciule the structure of this section with the larger "Tendermint Core" section
    • protocol stuff can probably in a separate Specification section
  • should link to the slate docs more docs: link to rpc #2361
  • update Reset section to use unsafe_reset_all f735d5e
  • link to config spec is broken
  • No Empty Blocks
    • remove "This much requested feature was implemented in version 0.10.3"
  • Adding a Validator -> should become two sections called:
    • "Adding a Validator at Genesis"
    • "Adding a Validator at Runtime"
      • this needs to be written and explained how to update the validator set using EndBlock in the application
      • needs to link to the EndBlock section of the app developers guide
    • This also needs to be easier to find - currently its doesn't even make it into the sidebar its so burried under TendermintCore->UsingTendermint->TendermintNetworks->AddingAValidator

Running in Production

Block Structure

SecureP2P

  • link to spec 13e0c98
  • update note about using nacl - we don't anymore!

Validators

  • document how the priv_validator.json works
  • document how an out-of-process validator like the KMS is supposed to work
  • include link to how to add validators section of Using Tendermint

Networks

  • Instead of "Deploy a Testnet", just make "Local Docker Testnet" and "Manual Deployment" subsections of "Tendermint Networks"
  • Fast Sync belongs under "Tendermint Core"

App Dev Guide

  • Can be simplified and make better use of the abci README and specification.md file in the repo
  • EndBlock
    • needs an update, no longer true about max +1/3
    • need to stress the change must have gone through consensus
    • explain that you have to return the full pubkey and link to somewhere that specifies what that looks like

Specification

Troubleshooting Guide #2328

  • addr_book_strict=false on local networks - ac4181b

Metadata

Metadata

Assignees

Labels

C:docsComponent: DocumentationT:bugType Bug (Confirmed)

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions