docs(legacy): added legacy documentation that was removed earlier#3494
docs(legacy): added legacy documentation that was removed earlier#3494
Conversation
…lder by reverting changes in commit 72d15a4 This partially reverts commit 72d15a4. Not restoring spec/reactors/consensus/proposer-selection.md: already present under spec/consensus. Not restoring block_sync_img/bc-reactor.png: already present under docs/references/architecture/tendermint-core/img. Not restoring mempool/concurrency.md as it is a TODO list that needs to be documented. Not restoring spec/reactors/mempool/config.md as it looks like an excerpt from the reference manual. We keep the reference manual up-to-date instead. Restoring spec/reactors/block_sync/img/bc-reactor-routines.png spec/reactors/consensus/consensus.md spec/reactors/consensus/consensus-reactor.md spec/reactors/mempool/functionality.md spec/reactors/block_sync/impl.md spec/reactors/mempool/messages.md spec/reactors/*/reactor.ms spec/reactors/readme.md (updated with legacy note) spellcheck ran on the files.
|
I identified bc-reactor.png as already present under architecture documentation and then I forgot to delete it from the commit. I'm open to suggestions to keep it or remove it. |
cason
left a comment
There was a problem hiding this comment.
So, there are parts of this documentation that are relevant, no questions about it. We need to do a short review on naming (Tendermint -> Comet) and other reactors that have changed names (e.g., fast sync/blockchain -> block sync).
I would suggest, however, to call the base directory spec/legacy instead of spec/reactors. And make it very clear that this is old documentation on the README.md entry file of this documentation, and also in all main files (README.md) on each directory.
spec/reactors/mempool/config.md
Outdated
There was a problem hiding this comment.
This is redundant with the documentation, also outdated.
There was a problem hiding this comment.
This is a bit TODO. Nice to have done, but not providing useful information with this content.
There was a problem hiding this comment.
This is probably mostly accurate. We can work a little on it and render it a relevant document.
There was a problem hiding this comment.
This file is confusing. We are handling reactor level messages in the consensus description. Not great, but something can be re-used here to produce a better documentation.
This file is still here. |
|
@greg-szabo , should I take this over? |
|
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
please do @cason 🙏 |
Co-authored-by: Daniel <daniel.cason@informal.systems>
removed spec/reactors/consensus/proposer-selection.md renamed reactor.md to README.md
add top-level readme fix links rename Tendermint to CometBFT
|
Approving so we can merge this. We can address @cason comments #3494 (review) in a separate PR. |
Refs #2718
Revert "spec: remove reactor section (#242)" Restore spec/reactors folder by reverting changes in commit 72d15a4
This partially reverts commit 72d15a4.
Restoring
These files are added (with a note that they are legacy documentation) as we did not find an updated version of them in our new folder structure. We should go through them, pick out the still relevant/useful information and decommission them for good.