Skip to content

docs: use dynamic versions across docs for mocha-4 and arabica-11 #2014

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

Merged
merged 1 commit into from
Apr 28, 2025

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Apr 28, 2025

Overview

Summary by CodeRabbit

  • Documentation
    • Updated multiple guides and tutorials to use dynamic chain ID placeholders instead of hardcoded values, improving maintainability and consistency across documentation.
    • Introduced Vue integration for dynamic templating in code examples and commands.
    • Enhanced code block syntax highlighting by switching to Vue-specific language tags.
    • Disabled certain markdown linting rules to support embedded scripts and longer lines.

@jcstein jcstein requested a review from Copilot April 28, 2025 17:38
Copy link
Contributor

coderabbitai bot commented Apr 28, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This set of changes updates multiple documentation markdown files to use dynamic template variables for network chain IDs and related constants, replacing previously hardcoded values such as "mocha-4" and "arabica-11". Vue <script setup> blocks are introduced at the top of relevant files to import a shared constants module and, where needed, Vue components. Code blocks within the documents are converted to use -vue language tags to support template interpolation. Markdown linting rules are selectively disabled to accommodate the new embedded scripts and longer lines. No procedural or logic changes are made to the underlying instructions; the updates focus on parameterizing network-specific values for maintainability and consistency.

Changes

File(s) Change Summary
how-to-guides/arabica-devnet.md, how-to-guides/mocha-testnet.md Added <script setup> blocks at the top to import constants and Vue components; replaced hardcoded chain IDs with template variables; moved and deduplicated import blocks; updated code blocks for Vue interpolation; disabled markdownlint rules for line length and inline HTML.
how-to-guides/ibc-relayer.md, how-to-guides/feegrant-for-blobs.md, how-to-guides/bridge-node.md, how-to-guides/light-node.md, how-to-guides/multiaccounts.md, how-to-guides/zfs.md, how-to-guides/celestia-node-troubleshooting.md, tutorials/celestia-node-key.md, tutorials/node-tutorial.md Replaced hardcoded chain IDs with template variables using imported constants; added or updated <script setup> blocks; changed code block language tags to support Vue interpolation; disabled markdownlint rules for formatting exceptions.
how-to-guides/blobstream.md Updated Celenium deployment URLs to use the "mocha.celenium.io" subdomain instead of "mocha-4.celenium.io"; no other changes.
tutorials/wallets.md Updated Leap wallet configuration instructions to use template expressions for RPC, REST, and block explorer URLs, replacing hardcoded domain names with dynamic constants.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MarkdownDoc
    participant ConstantsModule
    participant VueComponent

    User->>MarkdownDoc: Opens documentation
    MarkdownDoc->>ConstantsModule: Imports chain ID constants
    MarkdownDoc->>VueComponent: Imports (if required)
    MarkdownDoc->>MarkdownDoc: Renders content with {{constants.chainId}}
    User->>MarkdownDoc: Views dynamically rendered instructions/commands
Loading

Poem

In burrows deep, the docs were set,
With chain IDs fixed—now let’s not fret!
For constants hop in, dynamic and spry,
Vue tags and scripts let the values fly.
No more hardcodes, just templates anew,
Rabbits rejoice—maintenance made easy to do!
🥕✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 00002d8 and ed66537.

📒 Files selected for processing (13)
  • how-to-guides/arabica-devnet.md (4 hunks)
  • how-to-guides/blobstream.md (1 hunks)
  • how-to-guides/bridge-node.md (2 hunks)
  • how-to-guides/celestia-node-troubleshooting.md (1 hunks)
  • how-to-guides/feegrant-for-blobs.md (2 hunks)
  • how-to-guides/ibc-relayer.md (10 hunks)
  • how-to-guides/light-node.md (3 hunks)
  • how-to-guides/mocha-testnet.md (4 hunks)
  • how-to-guides/multiaccounts.md (2 hunks)
  • how-to-guides/zfs.md (1 hunks)
  • tutorials/celestia-node-key.md (7 hunks)
  • tutorials/node-tutorial.md (3 hunks)
  • tutorials/wallets.md (1 hunks)

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.

❤️ 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>, 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 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

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the documentation to use dynamic version constants for chain IDs and related URLs across various guides and tutorials. It replaces static references (e.g. "mocha-4", "arabica-11") with placeholders (e.g. {{constants.mochaChainId}}, {{constants.arabicaChainId}}) and updates code block language tags to new conventions.

  • Replaced hardcoded chain identifiers and URLs with dynamic constants.
  • Updated code fence language tags (e.g. from “bash” to “bash-vue”) and added markdownlint disable comments where needed.

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tutorials/wallets.md Updated RPC, REST, and explorer URLs to use dynamic Arabica chain ID constants.
tutorials/node-tutorial.md Replaced static Arabica chain IDs with dynamic constants and updated language tags for code blocks.
tutorials/celestia-node-key.md Swapped static Mocha testnet paths with dynamic constants; updated code fence tags.
how-to-guides/zfs.md Updated command examples to reference dynamic Mocha chain IDs in paths and endpoints.
how-to-guides/multiaccounts.md Replaced static Arabica identifiers with dynamic constants.
how-to-guides/mocha-testnet.md Revised multiple endpoint examples and channel identifiers with dynamic constants.
how-to-guides/light-node.md Updated command examples with dynamic Arabica chain IDs and adjusted code fence language tags.
how-to-guides/ibc-relayer.md Switched static Mocha chain IDs to dynamic constants throughout the configuration examples.
how-to-guides/feegrant-for-blobs.md Changed static Mocha chain IDs with dynamic constants in feegrant command examples.
how-to-guides/celestia-node-troubleshooting.md Updated error messages to use dynamic Mocha chain IDs.
how-to-guides/bridge-node.md Revised command examples to reference dynamic Arabica chain IDs.
how-to-guides/blobstream.md Adjusted deployment URLs for testnet blobstream endpoints (note potential pattern change).
how-to-guides/arabica-devnet.md Updated endpoints and command examples to use dynamic Arabica chain ID constants.
Comments suppressed due to low confidence (2)

how-to-guides/light-node.md:113

  • [nitpick] The code fence label appears inconsistent with other changes. Consider renaming it to '```sh-vue [Arabica]' for consistency.
```sh [Arabica]-vue

how-to-guides/blobstream.md:159

  • The blobstream URL domain changed from 'mocha-4.celenium.io' to 'mocha.celenium.io' which may be unintended if the project consistently uses dynamic chain IDs that include '-4'. Please confirm if this deviation is deliberate.
| SP1 Blobstream | Sepolia          | [`0xf0c6429ebab2e7dc6e05dafb61128be21f13cb1e`](https://sepolia.etherscan.io/address/0xf0c6429ebab2e7dc6e05dafb61128be21f13cb1e#events) | [Mocha testnet](/how-to-guides/mocha-testnet.md) | [Deployment on Celenium](https://mocha.celenium.io/blobstream?network=ethereum&page=1) |

@jcstein jcstein merged commit 87ac91e into main Apr 28, 2025
3 of 6 checks passed
@jcstein jcstein deleted the jcs/add-ver-to-cel-key-example branch April 28, 2025 17:39
@jcstein jcstein self-assigned this Apr 28, 2025
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.

1 participant