fix: remove reference to go-da repo #577
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @pthmas, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request focuses on enhancing the project's documentation by correcting outdated external links to the Data Availability interface and restructuring introductory content for better clarity and conciseness.
Highlights
- Documentation Link Updates: Updated several outdated links across the documentation that previously referenced the
go-darepository. These links now correctly point to the Data Availability (DA) interface definition located within therollkitrepository athttps://github.com/rollkit/rollkit/blob/main/core/da/da.go#L11. - Documentation Restructuring: Introduced a new 'Introduction' section at the beginning of the
learn/about.mdfile. This change aims to consolidate and improve the initial onboarding content, aligning with the goal of merging pages to avoid bloating.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
WalkthroughThis update revises Rollkit documentation by adding a new introduction to the "About" page, removing the separate "Intro" page, and updating references to the Data Availability (DA) interface in multiple documents to point directly to the relevant code in the Rollkit repository. Changes
Sequence Diagram(s)sequenceDiagram
participant Reader
participant Docs
Reader->>Docs: Access documentation
Docs-->>Reader: Show unified intro in "About"
Reader->>Docs: Follow DA interface link
Docs-->>Reader: Direct to specific DA interface code in Rollkit repo
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (3)
💤 Files with no reviewable changes (2)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
There was a problem hiding this comment.
Code Review
The pull request removes references to the go-da repository and updates links to point to the DA interface definition in the rollkit repository. The changes primarily affect markdown files in the blog and learn directories, updating links related to data availability layers and interfaces.
| @@ -52,7 +52,7 @@ It's using the [Celestia Node API](https://node-rpc-docs.celestia.org) | |||
| via the [`rollkit/celestia-da`](https://github.com/rollkit/celestia-da) package. | |||
| To deploy a Rollkit rollup on Celestia you also have to [run a Celestia light node](https://docs.celestia.org/developers/node-tutorial/). | |||
|
|
|||
| New DA layer integrations can be added by using the [go-da](https://github.com/rollkit/go-da) interface. | |||
| New DA layer integrations can be added by using the [DA interface](https://github.com/rollkit/rollkit/blob/main/core/da/da.go#L11). | |||
There was a problem hiding this comment.
Consider using a more descriptive name than "DA interface" for clarity. While the link provides context, the text itself could be more informative, such as "Data Availability (DA) interface".
| New DA layer integrations can be added by using the [DA interface](https://github.com/rollkit/rollkit/blob/main/core/da/da.go#L11). | |
| New DA layer integrations can be added by using the [Data Availability (DA) interface](https://github.com/rollkit/rollkit/blob/main/core/da/da.go#L11). |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
learn/about.md (1)
1-9: Avoid multiple top-level (#) headings in one page
# Introductionand# About Rollkitare both H1s. Many static-site generators (and SEO linters) expect a single H1 per document.
Convert the second one to## About Rollkit(or demote the first) to keep hierarchy valid.-# About Rollkit +## About Rollkitlearn/stack.md (2)
41-41: Make DA-interface link stableHard-coding
#L11ties the doc to the current line number, which will drift.
Either:
- Omit the line fragment:
core/da/da.go- Or use a permalink to a commit hash.
-[interfaces](https://github.com/rollkit/rollkit/blob/main/core/da/da.go#L11) +[interfaces](https://github.com/rollkit/rollkit/blob/main/core/da/da.go)
55-55: Same stability issue as aboveReplicate the fix here for consistency.
blog/rollkit-the-first-sovereign-rollup-framework.md (1)
60-60: Prefer durable link to DA interfaceSame rationale: drop the line anchor or switch to a commit permalink so future edits don’t 404.
-[DA interface](https://github.com/rollkit/rollkit/blob/main/core/da/da.go#L11) +[DA interface](https://github.com/rollkit/rollkit/blob/main/core/da/da.go)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
blog/rollkit-the-first-sovereign-rollup-framework.md(1 hunks)learn/about.md(1 hunks)learn/intro.md(0 hunks)learn/stack.md(2 hunks)
💤 Files with no reviewable changes (1)
- learn/intro.md
pthmas
force-pushed
the
pierrick/remove-go-da-repo
branch
from
b27b8ca to
b760480
Compare
Overview
Summary by CodeRabbit