Skip to content
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

Merged
merged 5 commits into from
Jun 17, 2024
Merged

Avail docs #392

merged 5 commits into from
Jun 17, 2024

Conversation

deepakgudla
Copy link
Contributor

@deepakgudla deepakgudla commented Jun 14, 2024

Avail DA Documentation

Summary by CodeRabbit

  • New Features
    • Added a new sidebar link titled "Avail" that links to a new tutorial on deploying a GM world rollup on Avail's data availability (DA) network.
    • Introduced a detailed tutorial covering the setup and deployment of an Avail light node on the Turing testnet.

Copy link
Contributor

coderabbitai bot commented Jun 14, 2024

Note

Reviews paused

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Walkthrough

This 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

File Change Summary
.vitepress/config.ts Added a new sidebar link titled "Avail" pointing to "/tutorials/avail-da" in sidebarHome().
tutorials/avail-da.md Added a new tutorial covering deployment of a GM world rollup on Avail's DA network.

Poem

A sidebar grows, with new delight,
The path to Avail now in sight,
Tutorials bloom where knowledge flows,
The rollup learns, the network knows.
In node's embrace, the light does gleam,
A coder's quest, a data dream. 🌟


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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Commits

Files that changed from the base of the PR and between a047e11 and b48dc54.

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 the init.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.sh

Length 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

@MSevey
Copy link
Contributor

MSevey commented Jun 14, 2024

pr preview expected to fail, lgtm 👍🏻

Copy link
Member

@jcstein jcstein left a 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

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Commits

Files that changed from the base of the PR and between b48dc54 and 26895a9.

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

jcstein and others added 2 commits June 14, 2024 13:02
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Commits

Files that changed from the base of the PR and between 26895a9 and 796ef68.

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Commits

Files that changed from the base of the PR and between 796ef68 and 2a35f14.

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

@MSevey
Copy link
Contributor

MSevey commented Jun 17, 2024

@coderabbitai resolve

@MSevey
Copy link
Contributor

MSevey commented Jun 17, 2024

@coderabbitai ignore

Copy link
Contributor

coderabbitai bot commented Jun 17, 2024

Actions performed

Comments resolved.

Copy link
Contributor

coderabbitai bot commented Jun 17, 2024

@coderabbitai ignore

Actions performed

Reviews paused.

Copy link
Member

@jcstein jcstein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK

@Manav-Aggarwal Manav-Aggarwal merged commit cf2ec57 into rollkit:main Jun 17, 2024
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants