feat: add DA overview and bring local-da into tutorials

MSevey commented 4 days ago

Overview

This PR pulls in the local-da how to guide into the DA section and adds a DA overview to explain the go-da interface.

Summary by CodeRabbit

New Features
- Introduced new tutorials for "Overview" and "Local DA" in the Data Availability section.
- Updated existing tutorials for "Celestia" and "Avail" to reflect new paths and improved content.
Documentation
- Enhanced clarity and organization in tutorials for using Avail and Celestia as Data Availability layers.
- Added a comprehensive overview of Rollkit's integration with Data Availability layers.

coderabbitai[bot] commented 4 days ago

Walkthrough

The pull request introduces several modifications to the VitePress site configuration and tutorial documents related to Data Availability (DA). It adds new sidebar entries for the "Tutorials" section, updates existing links, and modifies the transformPageData function for improved Open Graph metadata handling. Additionally, several tutorial documents have been revised for clarity and organization, with changes in titles, content structure, and the addition of a new tutorial on local DA.

Changes

File Path	Change Summary
`.vitepress/config.ts`	Added new sidebar entries for "DA" tutorials, updated existing links for "Celestia" and "Avail," and modified `transformPageData` function for `og:description` handling.
`tutorials/da/avail-da.md`	Changed title to "Using Avail as DA," added a disclaimer about tutorial status, updated instructions for running an Avail light node, and refined explanations for configuration flags and commands.
`tutorials/da/celestia-da.md`	Changed title to "Using Celestia as DA," updated introduction and light node instructions, streamlined funding explanations, and elaborated on configuration flags.
`tutorials/da/local-da.md`	New tutorial on setting up a local DA network node, including installation instructions and commands for connecting a rollup node to the local DA network.
`tutorials/da/overview.md`	New overview document detailing Rollkit's integration with DA layers, emphasizing the importance of DA layer selection and explaining the `go-da` interface.

Possibly related PRs

#373: This PR updates the sidebar navigation in .vitepress/config.ts, which is directly related to the changes made in the same file in the main PR, enhancing the navigation structure.
#392: Similar to the main PR, this PR modifies the .vitepress/config.ts file by adding a new sidebar link for "Avail," which aligns with the updates made to the sidebar structure in the main PR.
#404: This PR mentions the --rollkit.da_block_time flag in both the celestia-da.md and avail-da.md tutorials, which relates to the changes in the main PR that enhance the handling of Open Graph metadata and configuration.
#481: This PR updates the Celestia tutorial to use a "quick start" approach, which aligns with the main PR's focus on improving navigation and tutorial structure.
#486: This PR adds a disclaimer to the avail-da.md tutorial, which is relevant as the main PR also deals with the structure and content of tutorials related to data availability.

Suggested labels

documentation

Suggested reviewers

yarikbratashchuk
Manav-Aggarwal
jcstein
gupadhyaya

🐇 In the land of code, where changes flow,
New paths for learning, we joyfully sow.
With tutorials bright, and links that align,
Data Availability shines, oh how divine!
So hop through the docs, let knowledge abound,
In the world of Rollkit, new wonders are found! 🌟

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

github-actions[bot] commented 4 days ago

PR Preview Action v1.4.8 :---: :rocket: Deployed preview to https://rollkit.github.io/docs-preview/./pr-509/ on branch main at 2024-11-18 15:08 UTC

rollkit / docs