docs: update readme #934
docs: update readme #934
Conversation
WalkthroughThe changes involve a comprehensive rebranding of the project from "Tendermint" to "Tenderdash," reflected in the README.md and installation documentation. Key updates include modified repository links, badge links, and an introduction of a new "Background" section. The installation guide has been clarified with specific commands for setting up nodes and compiling with CLevelDB support. Overall, the documentation has been reorganized and updated to align with the new branding while retaining essential project information. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
thephez
requested review from
QuantumExplorer,
lklimek and
shumkov
as code owners
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (7)
docs/introduction/install.md (2)
11-11: LGTM! Consider adding version information.The updated link to the official Dash documentation for setting up a node using Dashmate is a great improvement. It provides users with a more specific and authoritative resource.
Consider adding a note about the compatibility of the linked Dashmate version with the current Tenderdash version to ensure users install the correct version.
Issues Found: Update Remaining "Tendermint" References to "Tenderdash"
The install.md file still contains instances of "Tendermint" which should be updated to "Tenderdash" for consistency with the project name. Please update the following instances:
Verify Installation Command:
- tendermint version + tenderdash versionStart One-Node Blockchain Commands:
- tendermint init validator - tendermint start --proxy-app=kvstore + tenderdash init validator + tenderdash start --proxy-app=kvstoreBuild Options:
- CGO_LDFLAGS="-lsnappy" make install TENDERMINT_BUILD_OPTIONS=cleveldb - CGO_LDFLAGS="-lsnappy" make build TENDERMINT_BUILD_OPTIONS=cleveldb + CGO_LDFLAGS="-lsnappy" make install TENDERDASH_BUILD_OPTIONS=cleveldb + CGO_LDFLAGS="-lsnappy" make build TENDERDASH_BUILD_OPTIONS=cleveldb5 occurrences of "Tendermint" were found and need to be addressed.
🔗 Analysis chain
Line range hint
1-146: Update remaining "Tendermint" references to "Tenderdash"The file still contains references to "Tendermint" which should be updated to "Tenderdash" for consistency with the project name. Please update the following instances:
In the command to verify installation:
-tendermint version +tenderdash versionIn the commands to start a one-node blockchain:
-tendermint init validator -tendermint start --proxy-app=kvstore +tenderdash init validator +tenderdash start --proxy-app=kvstoreIn the build options:
-CGO_LDFLAGS="-lsnappy" make install TENDERMINT_BUILD_OPTIONS=cleveldb -CGO_LDFLAGS="-lsnappy" make build TENDERMINT_BUILD_OPTIONS=cleveldb +CGO_LDFLAGS="-lsnappy" make install TENDERDASH_BUILD_OPTIONS=cleveldb +CGO_LDFLAGS="-lsnappy" make build TENDERDASH_BUILD_OPTIONS=cleveldbTo verify all occurrences of "Tendermint" in the file, you can run:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for "Tendermint" occurrences in the install.md file rg --ignore-case "tendermint" docs/introduction/install.mdLength of output: 278
README.md (5)
1-8: Update the banner image path to reflect Tenderdash branding.The title has been updated to "Tenderdash", but the banner image path still references Tendermint. Consider updating the image path to reflect the new project name.
- +Also, ensure that a new banner image for Tenderdash is created and placed in the correct location.
18-34: LGTM: Excellent addition of project background and context.The new Background section effectively explains the origins of Tenderdash and its relationship to Tendermint, which is valuable for users and potential contributors. The retention of Tendermint documentation references provides helpful historical context.
Minor suggestion:
Consider adding "the" before "Dash Platform's needs" in line 28 for improved readability:
-rapid transaction finality and maintain strong security guarantees make Tenderdash ideal for Dash +rapid transaction finality and maintain strong security guarantees make Tenderdash ideal for the Dash Platform's needs.🧰 Tools
🪛 LanguageTool
[uncategorized] ~28-~28: You might be missing the article “the” here.
Context: ...ty guarantees make Tenderdash ideal for Dash Platform’s needs. For Tendermint proto...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
52-67: LGTM: Clear versioning and support policy.The Versioning section effectively communicates both the semantic versioning approach and the current support policy for Tenderdash.
Minor stylistic suggestion:
Consider rephrasing the sentence in lines 65-67 for better readability:
-Because we are a small core team, we only ship patch updates, including security updates, to the -most recent minor release and the second-most recent minor release. Consequently, we strongly -recommend keeping Tenderdash up-to-date. +Because we are a small core team, we only ship patch updates, including security updates, to the +two most recent minor releases. Consequently, we strongly recommend keeping Tenderdash up-to-date.This rephrasing maintains the meaning while simplifying the sentence structure.
🧰 Tools
🪛 LanguageTool
[style] ~66-~66: This is not the usual sequence for adjectives that have no special emphasis.
Context: ...including security updates, to the most recent minor release and the second-most recent mino...(EN_ADJ_ORDER)
[style] ~66-~66: This is not the usual sequence for adjectives that have no special emphasis.
Context: ...ecent minor release and the second-most recent minor release. Consequently, we strongly reco...(EN_ADJ_ORDER)
69-73: Consider adding a note about the relevance of Tendermint resources.While retaining these Tendermint-related resources is valuable for historical context, it might be helpful to add a brief note explaining their relevance to Tenderdash. This could help new users understand the connection between Tendermint and Tenderdash.
Consider adding a short explanation, such as:
## Resources The following resources, while focused on Tendermint, provide valuable background information that is also relevant to Tenderdash: - [The latest gossip on BFT consensus](https://arxiv.org/abs/1807.04938) - [Master's Thesis on Tendermint](https://atrium.lib.uoguelph.ca/xmlui/handle/10214/9769) - [Original Whitepaper: "Tendermint: Consensus Without Mining"](https://tendermint.com/static/docs/tendermint.pdf)
75-86: LGTM: Clear contribution guidelines and project affiliation.The updates to the Contributing and Join us sections effectively communicate the project's guidelines and affiliation with Dash Core Group.
Minor suggestion for the Contributing section:
Consider rephrasing the opening sentence to be more direct:
-Before contributing to the project, please take a look at the [contributing -guidelines](CONTRIBUTING.md) and the [style guide](STYLE_GUIDE.md). You may also find it helpful to +Before contributing to the project, please read the [contributing +guidelines](CONTRIBUTING.md) and the [style guide](STYLE_GUIDE.md). You may also find it helpful to read the [Tendermint specifications](./spec/README.md), and familiarize yourself with the [Architectural Decision Records (ADRs)](./docs/architecture/README.md) and [Request For Comments (RFCs)](./docs/rfc/README.md).This change makes the instruction more direct and emphasizes the importance of reading the guidelines.
🧰 Tools
🪛 LanguageTool
[style] ~77-~77: To make your writing clearer, consider a more direct alternative.
Context: ...ore contributing to the project, please take a look at the [contributing guidelines](C...(TAKE_A_LOOK)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- README.md (1 hunks)
- docs/introduction/install.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~28-~28: You might be missing the article “the” here.
Context: ...ty guarantees make Tenderdash ideal for Dash Platform’s needs. For Tendermint proto...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~66-~66: This is not the usual sequence for adjectives that have no special emphasis.
Context: ...including security updates, to the most recent minor release and the second-most recent mino...(EN_ADJ_ORDER)
[style] ~66-~66: This is not the usual sequence for adjectives that have no special emphasis.
Context: ...ecent minor release and the second-most recent minor release. Consequently, we strongly reco...(EN_ADJ_ORDER)
[style] ~77-~77: To make your writing clearer, consider a more direct alternative.
Context: ...ore contributing to the project, please take a look at the [contributing guidelines](C...(TAKE_A_LOOK)
🔇 Additional comments (3)
README.md (3)
9-16: LGTM: Badge updates are consistent and correct.The badge links have been successfully updated to reflect the new "dashpay/tenderdash" repository and Dash-specific resources. This change is consistent with the project rebranding effort.
36-50: LGTM: Clear and concise installation information.The Releases and Install sections have been updated appropriately to reflect the new project repository. The reformatted Minimum requirements table improves readability and clarity.
1-86: Overall, excellent rebranding and update of the README.The changes effectively transition the project from Tendermint to Tenderdash while maintaining valuable historical context. The document now accurately represents Tenderdash as a fork of Tendermint with specific enhancements, providing clear information for users and potential contributors.
Key strengths:
- Clear explanation of Tenderdash's background and relationship to Tendermint
- Updated repository links and badges
- Retention of relevant Tendermint resources with added context
- Clear contribution guidelines and project affiliation
The suggested minor improvements, if implemented, will further enhance the document's clarity and readability.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~28-~28: You might be missing the article “the” here.
Context: ...ty guarantees make Tenderdash ideal for Dash Platform’s needs. For Tendermint proto...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~66-~66: This is not the usual sequence for adjectives that have no special emphasis.
Context: ...including security updates, to the most recent minor release and the second-most recent mino...(EN_ADJ_ORDER)
[style] ~66-~66: This is not the usual sequence for adjectives that have no special emphasis.
Context: ...ecent minor release and the second-most recent minor release. Consequently, we strongly reco...(EN_ADJ_ORDER)
[style] ~77-~77: To make your writing clearer, consider a more direct alternative.
Context: ...ore contributing to the project, please take a look at the [contributing guidelines](C...(TAKE_A_LOOK)
Issue being fixed or feature implemented
Many badges and a lot of text still referenced Tendermint
Still needs updated image (could be in another PR)
What was done?
Updated badges to actually reference Tenderdash stuff instead of Tendermint. Removed some content that seems irrelevant to Tenderdash.
Preview: https://github.com/thephez/tenderdash/blob/readme-update/README.md
How Has This Been Tested?
Previewed file
Breaking Changes
N/A
Checklist:
For repository code-owners and collaborators only
Summary by CodeRabbit
New Features
Documentation
Chores