docs: Update readme.md #407
Conversation
spoo-bar
commented
Oct 1, 2024
spoo-bar
commented
- Including details about the new assets and modules and
- Removing token factory specific details
- Moving some stuff around to organize the flow better
WalkthroughThe 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (7)
readme.md (7)
4-6: Excellent introduction enhancement!The expanded introduction provides a clear and informative overview of Noble's purpose, vision, and technical foundation. The addition of links to relevant assets enhances the usefulness of the documentation.
For consistency, consider adding hyperlinks to "Cosmos-SDK" and "application-specific blockchain" in the last sentence, similar to how you've linked other terms.
🧰 Tools
🪛 LanguageTool
[style] ~4-~4: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...onerium's EURe](https://monerium.com/). Noble’s vision is to be the world’s premier i...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~4-~4: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...onnect to other blockchains seamlessly. Noble leverages the Cosmos-SDK – a flexible t...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
18-22: Improved focus on key chain design aspectsThe renamed and condensed "Noble Chain Design" section provides a clearer overview of the consensus mechanism and economic security model. This streamlining aligns well with the PR objectives.
Consider adding a brief mention of the Owner, Minter, and Blacklist roles that were removed, or provide a link to more detailed documentation about these roles if available. This would help maintain the completeness of the information while keeping the main content concise.
24-32: Excellent presentation of assets on NobleThe renamed "Assets on Noble" section with the added table provides a clear and concise overview of the assets implemented on Noble. This aligns well with the PR objective of adding details about new assets and modules.
For consistency, consider adding hyperlinks to the issuer names in the table, similar to how you've linked the module names.
35-45: Great addition of protocol features overviewThe new "Protocol features" section with its table of modules and their features provides valuable information about Noble's capabilities. This addition aligns well with the PR objective of enhancing documentation about the project's offerings.
For consistency, consider adding hyperlinks to the module names in the "Module name" column, similar to how you've linked some of them already.
🧰 Tools
🪛 LanguageTool
[misspelling] ~42-~42: This word is normally spelled with a hyphen.
Context: ...llows a custom account type on Noble to auto forward any tokens it receives to an address on...(EN_COMPOUNDS_AUTO_FORWARD)
Line range hint
55-89: Improved clarity in governance documentationThe reformatted Noble Upgrades & Governance section provides clearer information about the Noble Maintenance Multisig (NMM) and its governance structure. This improvement aligns well with the PR objective of enhancing content organization.
Consider the following minor formatting improvements for consistency:
- Use bold text for the main subsection titles (e.g., Upgrade Authority, Parameter Changes, etc.) to improve readability.
- Ensure consistent capitalization in bullet points (e.g., "Noble (the organization): Canada" vs "Iqlusion: USA").
- Consider using a numbered list for the proposed geographies to match the format used in other parts of the document.
🧰 Tools
🪛 Markdownlint
95-95: null
Bare URL used(MD034, no-bare-urls)
96-96: null
Bare URL used(MD034, no-bare-urls)
97-97: null
Bare URL used(MD034, no-bare-urls)
99-99: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
109-109: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
89-121: Valuable addition of developer instructions and contribution guidanceThe new sections for developers, including setup instructions and local running guidelines, provide valuable information for those looking to work with Noble. The update to the Contributing section clearly states the project's stance on external contributions.
Consider the following improvements for the developer instructions:
Use code blocks with language specifiers for the installation commands to improve readability and enable syntax highlighting. For example:
git clone https://github.com/noble-assets/noble cd noble make installConsider adding a brief explanation of what the
play.shscript does before instructing users to run it.For consistency, consider using bullet points for the software requirements instead of a numbered list, as bullet points are used more frequently throughout the document.
In the "For Node Operators & Validators" section, correct the typo "testent" to "testnet".
🧰 Tools
🪛 Markdownlint
95-95: null
Bare URL used(MD034, no-bare-urls)
96-96: null
Bare URL used(MD034, no-bare-urls)
97-97: null
Bare URL used(MD034, no-bare-urls)
99-99: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
109-109: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Line range hint
1-121: Excellent overall restructuring and content enhancementThe significant restructuring and reformatting of the readme.md file have greatly improved its organization, readability, and informativeness. These changes align well with the PR objectives of enhancing documentation and improving content organization.
To further improve consistency throughout the document:
- Ensure all external references (e.g., Cosmos-SDK, application-specific blockchain) are consistently hyperlinked.
- Standardize the use of bullet points vs. numbered lists for similar types of content.
- Ensure consistent capitalization in headings and list items.
- Consider adding a brief introduction or purpose statement at the beginning of each main section to provide context.
These minor adjustments will further enhance the document's professional appearance and usability.
🧰 Tools
🪛 LanguageTool
[style] ~4-~4: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...onerium's EURe](https://monerium.com/). Noble’s vision is to be the world’s premier i...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~4-~4: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...onnect to other blockchains seamlessly. Noble leverages the Cosmos-SDK – a flexible t...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[misspelling] ~42-~42: This word is normally spelled with a hyphen.
Context: ...llows a custom account type on Noble to auto forward any tokens it receives to an address on...(EN_COMPOUNDS_AUTO_FORWARD)
[style] ~49-~49: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... ## Noble on the Interchain App-chains are able to permissionlessly connect to Noble [via ...(BE_ABLE_TO)
🪛 Markdownlint
51-51: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- readme.md (2 hunks)
🧰 Additional context used
🪛 LanguageTool
readme.md
[style] ~4-~4: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...onerium's EURe](https://monerium.com/). Noble’s vision is to be the world’s premier i...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~4-~4: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...onnect to other blockchains seamlessly. Noble leverages the Cosmos-SDK – a flexible t...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[misspelling] ~42-~42: This word is normally spelled with a hyphen.
Context: ...llows a custom account type on Noble to auto forward any tokens it receives to an address on...(EN_COMPOUNDS_AUTO_FORWARD)
[style] ~49-~49: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... ## Noble on the Interchain App-chains are able to permissionlessly connect to Noble [via ...(BE_ABLE_TO)
🪛 Markdownlint
readme.md
51-51: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
95-95: null
Bare URL used(MD034, no-bare-urls)
96-96: null
Bare URL used(MD034, no-bare-urls)
97-97: null
Bare URL used(MD034, no-bare-urls)
99-99: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
109-109: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🔇 Additional comments (1)
readme.md (1)
8-16: Great addition of a table of contents!The new table of contents significantly improves the document's navigability and provides a clear overview of its structure. This enhancement aligns well with the PR objective of improving content organization.
| ## Noble on the Interchain | ||
|
|
||
| App-chains are able to permissionlessly connect to Noble [via IBC](https://medium.com/the-interchain-foundation/eli5-what-is-ibc-def44d7b5b4c), a universal interoperability protocol that allows two different blockchains to communicate with one another, garaunteeing reliable, ordered, and authenticated communication. | ||
|
|
||
| How to integrate with Noble? | ||
| #### How to integrate with Noble? | ||
|
|
||
| To establish a connection to Noble (or any 2 IBC compatible chains), developers will be required to set up a relayer on an existing path. This [tutorial](https://github.com/cosmos/relayer/blob/main/docs/create-path-across-chain.md) gives an overview of how to create a channel, client, and connection and to start relaying IBC packets. | ||
| To establish a connection to Noble (or any 2 IBC compatible chains), anybody can set up a relayer on an existing path. This [tutorial](https://github.com/cosmos/relayer/blob/main/docs/create-path-across-chain.md) gives an overview of how to create a channel, client, and connection and to start relaying IBC packets. |
There was a problem hiding this comment.
Improved interoperability documentation
The renamed "Noble on the Interchain" section provides clearer information about Noble's interoperability and integration instructions. This improvement aligns well with the PR objective of enhancing documentation.
There's an inconsistency in the heading level for "How to integrate with Noble?". It's currently an h4 (####) when it should be an h3 (###) to maintain the correct hierarchy.
Please update the heading as follows:
-#### How to integrate with Noble?
+### How to integrate with Noble?📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Noble on the Interchain | |
| App-chains are able to permissionlessly connect to Noble [via IBC](https://medium.com/the-interchain-foundation/eli5-what-is-ibc-def44d7b5b4c), a universal interoperability protocol that allows two different blockchains to communicate with one another, garaunteeing reliable, ordered, and authenticated communication. | |
| How to integrate with Noble? | |
| #### How to integrate with Noble? | |
| To establish a connection to Noble (or any 2 IBC compatible chains), developers will be required to set up a relayer on an existing path. This [tutorial](https://github.com/cosmos/relayer/blob/main/docs/create-path-across-chain.md) gives an overview of how to create a channel, client, and connection and to start relaying IBC packets. | |
| To establish a connection to Noble (or any 2 IBC compatible chains), anybody can set up a relayer on an existing path. This [tutorial](https://github.com/cosmos/relayer/blob/main/docs/create-path-across-chain.md) gives an overview of how to create a channel, client, and connection and to start relaying IBC packets. | |
| ## Noble on the Interchain | |
| App-chains are able to permissionlessly connect to Noble [via IBC](https://medium.com/the-interchain-foundation/eli5-what-is-ibc-def44d7b5b4c), a universal interoperability protocol that allows two different blockchains to communicate with one another, garaunteeing reliable, ordered, and authenticated communication. | |
| ### How to integrate with Noble? | |
| To establish a connection to Noble (or any 2 IBC compatible chains), anybody can set up a relayer on an existing path. This [tutorial](https://github.com/cosmos/relayer/blob/main/docs/create-path-across-chain.md) gives an overview of how to create a channel, client, and connection and to start relaying IBC packets. |
🧰 Tools
🪛 LanguageTool
[style] ~49-~49: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... ## Noble on the Interchain App-chains are able to permissionlessly connect to Noble [via ...(BE_ABLE_TO)
🪛 Markdownlint
51-51: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
