docs icon indicating copy to clipboard operation
docs copied to clipboard

docs: adding documentation for running Madara app chains with Celestia

Open SamrendraS opened this issue 1 year ago • 3 comments

Overview

Adding Madara to Celestia docs to facilitate integrating Celestia with App Chains built on Madara.

Checklist

  • [X] New and updated code has appropriate documentation
  • [X] New and updated code has new and/or updated testing
  • [X] Required CI checks are passing
  • [X] Visual proof for any user facing features like CLI or documentation updates
  • [X] Linked issues closed with keywords

Summary by CodeRabbit

  • New Features

    • Added comprehensive documentation for the "Astria" section, including deployment guides and links.
    • Introduced a new "Starknet" section, featuring "Deploy to Dusknet" and "Rollups-as-a-Service" with a link to "Karnot".
    • New guides for getting started with Madara, including setup methods, deployment, and interaction instructions.
    • Added integration guidance for Celestia with Madara for blockchain applications.
    • Explained the relationship between Madara and Starknet for developers.
  • Documentation

    • Updated links for "Sovereign SDK", "Vistara", and "Celestia Foundation Delegation Program".

SamrendraS avatar Mar 06 '24 09:03 SamrendraS

Walkthrough

The recent updates involve expanding and reorganizing documentation to include a new section for "Astria," moving content to a new "Starknet" section, and adding "Rollups-as-a-Service" with specific links. It also updates several links and introduces comprehensive guides for setting up and integrating Madara with blockchain applications, highlighting the synergy between Madara, Starknet, and Celestia in the process.

Changes

Files Summary
.vitepress/config.ts Added "Astria" section, reorganized into "Starknet", added "Rollups-as-a-Service" with "Karnot" link, updated various links.
developers/madara-get-started.md
developers/madara-integration.md
developers/madara-starknet.md
Introduced guides for setting up Madara, integrating with Celestia, and explaining Madara's relationship with Starknet.

Related issues

  • celestiaorg/docs#1456: The addition of Madara documentation, especially its integration with Celestia, directly addresses the issue's request for documentation on building app chains with Madara and integrating them into Celestia.

🐇✨ In the realm of code, where the blockchain weaves, A rabbit hopped in, with updates up its sleeves. "Astria and Starknet," it cheerfully said, "With Madara's might, let's forge ahead!" Through docs and guides, our journey we chart, In the world of tech, we all play a part. 🌟📚🚀

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-tests 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 tests 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 tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai[bot] avatar Mar 06 '24 09:03 coderabbitai[bot]

also, i plan to review this in full and test next week 🫡

jcstein avatar Mar 08 '24 15:03 jcstein

nudging here @SamrendraS, I will plan to check back tomorrow and implement change myself if no update then

jcstein avatar Mar 11 '24 19:03 jcstein

Closing this as it is stale. Please reopen when you have resolved the above!

jcstein avatar Jun 20 '24 22:06 jcstein