Skip to content

docs: add blobstream example#1533

Merged
jcstein merged 3 commits intomainfrom
jcs/add-blobstream-example
May 1, 2024
Merged

docs: add blobstream example#1533
jcstein merged 3 commits intomainfrom
jcs/add-blobstream-example

Conversation

@jcstein
Copy link
Copy Markdown
Member

@jcstein jcstein commented Apr 18, 2024 •
edited by coderabbitai bot
Loading

Overview

Screenshot 2024-04-18 at 11 31 17 AM

This PR also fixes a link that I gave @rach-id the wrong path for 🙈

Summary by CodeRabbit

  • New Features

    • Added an example implementation of Blobstream proofs by CryptoKass with a GitHub repository link in the sidebar navigation.

  • Documentation

    • Updated a hyperlink in the documentation related to building blobstream rollups to point to the correct location.

@jcstein jcstein requested a review from rach-id April 18, 2024 15:30
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 18, 2024 •
edited
Loading

Walkthrough

The recent updates bring improvements to Blobstream technology documentation. An example implementation by CryptoKass is now easily accessible in the Vitepress sidebar. Additionally, a hyperlink in the Blobstream docs now correctly directs users to the rollup construction resource.

Changes

File Path Change Summary
.vitepress/config.ts,
developers/.../blobstream.md		 Added CryptoKass's Blobstream example to sidebar navigation;
Updated hyperlink to correct rollup construction resource

🐰✨
In the digital fields where data streams flow,
A rabbit hopped, leaving marks in the snow.
With a tweak and a link, paths were set right,
Now guides glow clear, in the soft moonlight.
Hop, hop, hurray, to the changes we sow! 🌟
🐰✨

Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 234c074 and 0fa50ce.
Files selected for processing (1)
  • .vitepress/config.ts (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • .vitepress/config.ts

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.

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.
  • 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.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 18, 2024 •
edited
Loading

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-05-01 15:05 UTC

@jcstein jcstein marked this pull request as ready for review April 18, 2024 15:32
rach-id
rach-id reviewed Apr 18, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@rach-id rach-id left a comment

Choose a reason for hiding this comment

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

:shipit:

Comment thread .vitepress/config.ts Outdated
link: "/developers/blobstream-proof-queries",
},
{
text: "Example implementation of Blobstream by CryptoKass",
Copy link
Copy Markdown
Member

@rach-id rach-id Apr 18, 2024

Choose a reason for hiding this comment

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

Should ask for his permission first?

Copy link
Copy Markdown
Member Author

@jcstein jcstein Apr 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@CryptoKass would you like us to add this? do yo have any suggested changes for this?

Copy link
Copy Markdown
Contributor

@CryptoKass CryptoKass May 1, 2024

Choose a reason for hiding this comment

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

This looks good 👍

rach-id
rach-id reviewed Apr 18, 2024
View reviewed changes
Comment thread .vitepress/config.ts Outdated
@jcstein @rach-id
Update .vitepress/config.ts
0fa50ce 
Co-authored-by: CHAMI Rachid <chamirachid1@gmail.com>
@jcstein jcstein self-assigned this Apr 22, 2024
@jcstein jcstein requested a review from rach-id May 1, 2024 15:04
@jcstein jcstein enabled auto-merge (squash) May 1, 2024 15:05
@jcstein jcstein disabled auto-merge May 1, 2024 15:05
@jcstein jcstein merged commit 5187625 into main May 1, 2024
@jcstein jcstein deleted the jcs/add-blobstream-example branch May 1, 2024 15:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rach-id rach-id Awaiting requested review from rach-id

1 more reviewer

@CryptoKass CryptoKass CryptoKass left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@jcstein jcstein

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jcstein @CryptoKass @rach-id