-
Notifications
You must be signed in to change notification settings - Fork 58
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Avail docs #392
Avail docs #392
Conversation
Note Reviews pausedUse the following commands to manage reviews:
WalkthroughThis update introduces a tutorial for deploying a GM world rollup on Avail's data availability network and makes a minor enhancement to the sidebar by adding a link to this new tutorial. The tutorial details setting up an Avail light node, cleaning chain history, and configuring necessary flags. 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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 4
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- .vitepress/config.ts (1 hunks)
- tutorials/avail-da.md (1 hunks)
Files skipped from review due to trivial changes (1)
- .vitepress/config.ts
Additional context used
LanguageTool
tutorials/avail-da.md
[uncategorized] ~71-~71: A comma is probably missing here. (MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
Context: ...PC endpoint provided by avail Labs. For local it would be - [https://localhost:8000/v...
Markdownlint
tutorials/avail-da.md
24-24: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
26-26: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
28-28: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
33-33: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
23-23: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
27-27: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
27-27: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
Additional comments not posted (2)
tutorials/avail-da.md (2)
3-9
: Introduction section is well-written and provides a good overview of the tutorial's purpose.
52-60
: Ensure theinit.sh
script is safe and performs as expected. Consider adding a brief description of what the script does for clarity.Verification successful
The
init.sh
script has been located and its contents reviewed. The script appears to be setting up and initializing a blockchain environment, including building the chain, resetting existing data, initializing a validator, adding keys and genesis accounts, and starting the chain.The script looks comprehensive and does not contain any obvious security issues or harmful commands. However, providing a brief description in the tutorial about what the script does will indeed enhance clarity for users.
- Consider adding a brief description of what the
init.sh
script does in the tutorial.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the safety and functionality of the init.sh script. cat $HOME/gm/init.shLength of output: 89
Script:
#!/bin/bash # Description: Locate the init.sh script within the repository and display its contents. fd init.sh --exec cat {}Length of output: 4746
pr preview expected to fail, lgtm 👍🏻 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
made suggestions mostly on capitalization and some linting
otherwise LGTM after those are resolved
b48dc54
to
26895a9
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 6
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- .vitepress/config.ts (1 hunks)
- tutorials/avail-da.md (1 hunks)
Files not summarized due to errors (1)
- tutorials/avail-da.md: Error: Server error. Please try again later.
Files skipped from review due to trivial changes (1)
- .vitepress/config.ts
Additional context used
LanguageTool
tutorials/avail-da.md
[uncategorized] ~71-~71: A comma is probably missing here. (MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
Context: ...PC endpoint provided by avail Labs. For local it would be - [https://localhost:8000/v...
Markdownlint
tutorials/avail-da.md
24-24: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
26-26: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
28-28: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
33-33: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
23-23: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
27-27: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
27-27: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 7
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- tutorials/avail-da.md (1 hunks)
Additional context used
Markdownlint
tutorials/avail-da.md
24-24: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
26-26: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
28-28: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
33-33: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
23-23: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
27-27: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
27-27: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
Additional comments not posted (1)
tutorials/avail-da.md (1)
24-26
: Ensure fenced code blocks are surrounded by blank lines.- Example: + Example: + - avail_secret_uri = '<paste your mnemonic here>' + avail_secret_uri = '<paste your mnemonic here>' +Likely invalid or redundant comment.
Tools
Markdownlint
24-24: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
26-26: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- tutorials/avail-da.md (1 hunks)
Additional context used
LanguageTool
tutorials/avail-da.md
[uncategorized] ~13-~13: A comma might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
Context: ...nd possibly fund a light node on Turing Testnet which is the test network of Avail - [...
[uncategorized] ~29-~29: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ... just an Avail light node is enough for Turing testnet. Run the Avail light node using...
Markdownlint
tutorials/avail-da.md
30-30: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
@coderabbitai resolve |
@coderabbitai ignore |
Actions performedComments resolved. |
@coderabbitai ignore Actions performedReviews paused. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
utACK
Avail DA Documentation
Summary by CodeRabbit