Skip to content

docs: add mammoth testnet#1969

Merged
jcstein merged 22 commits intomainfrom
jcs/mammoth
Apr 14, 2025
Merged

docs: add mammoth testnet#1969
jcstein merged 22 commits intomainfrom
jcs/mammoth

Conversation

@jcstein
Copy link
Copy Markdown
Member

@jcstein jcstein commented Apr 4, 2025

Overview

  • Add preview image
  • review endpoints before merging
  • review throughput
  • Review commands
  • check versions are latest
  • add mammoth to gmamo.vercel.app as default

Summary by CodeRabbit

  • New Features
    • Added a Mammoth testnet entry to the navigation for quick access to testnet guides.
  • Documentation
    • Introduced detailed documentation on the Mammoth testnet, covering network parameters, node setup, RPC endpoints, and data interaction instructions, complete with visual aids for enhanced understanding.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 4, 2025

Walkthrough

This pull request adds a new sidebar item labeled "Mammoth testnet" to the project's documentation configuration and introduces a corresponding markdown file with detailed documentation for the Mammoth testnet. The documentation covers aspects such as testnet parameters, node setup instructions, network architecture, and RPC endpoints. Both changes follow existing formatting and organization practices.

Changes

File(s) Change Summary
.vitepress/config.ts Added a new sidebar entry "Mammoth testnet" under the "How-to guides" section.
how-to-guides/mammoth.md New documentation file providing a comprehensive overview of the Mammoth testnet including parameters, node configurations, and setup steps.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant S as Sidebar
    participant D as Documentation Page
    U->>S: Click "Mammoth testnet" link
    S->>D: Navigate to mammoth.md page
    D-->>U: Display Mammoth testnet documentation
Loading

Possibly related PRs

Suggested labels

documentation

Poem

Oh, what a hop and a joyous leap,
For sidebar paths and docs so deep.
"Mammoth testnet" now lights up the way,
Guided steps for code at play.
I, the bunny, cheer with delight—
Carrots and commits in our code-filled night!
🐇✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
✨ Finishing Touches
  • 📝 Generate Docstrings

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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@jcstein jcstein requested a review from Copilot April 4, 2025 17:52
@jcstein jcstein self-assigned this Apr 4, 2025
Copy link
Copy Markdown
Contributor

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.

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 4, 2025

PR Preview Action v1.6.1
Preview removed because the pull request was closed.
2025-04-14 13:55 UTC

@jcstein jcstein marked this pull request as ready for review April 14, 2025 13:40
@jcstein jcstein requested review from cmwaters and Copilot April 14, 2025 13:41
Copy link
Copy Markdown
Contributor

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.

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
how-to-guides/mammoth.md (3)

37-44: Format URLs as proper markdown links in the table

The URLs in the RPC endpoints table should be formatted as proper markdown links for better accessibility and to follow markdown best practices.

-| Amsterdam | https://global.grpc.mamochain.com | https://rpc.ams.mamochain.com | https://api.ams.mamochain.com |
-| Paris | https://global.grpc.mamochain.com | https://rpc.par.mamochain.com | https://api.par.mamochain.com |
-| Warsaw | https://global.grpc.mamochain.com | https://rpc.waw.mamochain.com | https://api.waw.mamochain.com |
+| Amsterdam | [https://global.grpc.mamochain.com](https://global.grpc.mamochain.com) | [https://rpc.ams.mamochain.com](https://rpc.ams.mamochain.com) | [https://api.ams.mamochain.com](https://api.ams.mamochain.com) |
+| Paris | [https://global.grpc.mamochain.com](https://global.grpc.mamochain.com) | [https://rpc.par.mamochain.com](https://rpc.par.mamochain.com) | [https://api.par.mamochain.com](https://api.par.mamochain.com) |
+| Warsaw | [https://global.grpc.mamochain.com](https://global.grpc.mamochain.com) | [https://rpc.waw.mamochain.com](https://rpc.waw.mamochain.com) | [https://api.waw.mamochain.com](https://api.waw.mamochain.com) |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

41-41: Bare URL used
null

(MD034, no-bare-urls)


41-41: Bare URL used
null

(MD034, no-bare-urls)


41-41: Bare URL used
null

(MD034, no-bare-urls)


42-42: Bare URL used
null

(MD034, no-bare-urls)


42-42: Bare URL used
null

(MD034, no-bare-urls)


42-42: Bare URL used
null

(MD034, no-bare-urls)


43-43: Bare URL used
null

(MD034, no-bare-urls)


43-43: Bare URL used
null

(MD034, no-bare-urls)


43-43: Bare URL used
null

(MD034, no-bare-urls)


81-82: Format the status URL as a proper markdown link

Similar to the RPC endpoints table, this URL should be formatted as a proper markdown link.

-Status: <https://rpc.ams.mamochain.com/status>
+Status: [https://rpc.ams.mamochain.com/status](https://rpc.ams.mamochain.com/status)

190-193: Fix anchor links in the list

The anchor links have incorrect formatting and won't work properly. The IDs in the document use hyphens instead of spaces, but these link fragments don't match that pattern.

-[View your node information and transfer TIA](#see-your-node-s-info)
-[Monitor sampling statistics](#see-your-node-s-sampling-stats)
+[View your node information and transfer TIA](#see-your-nodes-info)
+[Monitor sampling statistics](#see-your-nodes-sampling-stats)

Also update the corresponding heading IDs to match:

-#### See your node's info
+#### See your nodes info

-#### See your node's sampling stats
+#### See your nodes sampling stats
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

190-190: Link fragments should be valid
null

(MD051, link-fragments)


191-191: Link fragments should be valid
null

(MD051, link-fragments)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ce3aafa and 99d0396.

⛔ Files ignored due to path filters (8)
  • public/img/mamo-1.png is excluded by !**/*.png
  • public/img/mamo/mamo-blob.png is excluded by !**/*.png
  • public/img/mamo/mamo-dbenter.png is excluded by !**/*.png
  • public/img/mamo/mamo-dbstart.png is excluded by !**/*.png
  • public/img/mamo/mamo-nodeinfo.png is excluded by !**/*.png
  • public/img/mamo/mamo-post.png is excluded by !**/*.png
  • public/img/mamo/mamo-retrieve.png is excluded by !**/*.png
  • public/img/mamo/mamo-sampler.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • .vitepress/config.ts (1 hunks)
  • how-to-guides/mammoth.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
how-to-guides/mammoth.md

41-41: Bare URL used
null

(MD034, no-bare-urls)


41-41: Bare URL used
null

(MD034, no-bare-urls)


41-41: Bare URL used
null

(MD034, no-bare-urls)


42-42: Bare URL used
null

(MD034, no-bare-urls)


42-42: Bare URL used
null

(MD034, no-bare-urls)


42-42: Bare URL used
null

(MD034, no-bare-urls)


43-43: Bare URL used
null

(MD034, no-bare-urls)


43-43: Bare URL used
null

(MD034, no-bare-urls)


43-43: Bare URL used
null

(MD034, no-bare-urls)


190-190: Link fragments should be valid
null

(MD051, link-fragments)


191-191: Link fragments should be valid
null

(MD051, link-fragments)

🔇 Additional comments (10)
.vitepress/config.ts (1)

411-414: LGTM: Navigation item added correctly

The Mammoth testnet sidebar item is properly structured and follows the same pattern as other network entries.

how-to-guides/mammoth.md (9)

1-5: LGTM: Clear introduction to the Mammoth testnet

The introduction effectively explains the purpose of this testnet - demonstrating Celestia's high throughput capabilities in conditions that mirror a real network.


7-15: LGTM: Well-structured overview with key parameters

The parameter table provides all essential information users need to interact with the testnet.


16-23: LGTM: Clear chain details and explorer information

The infrastructure details provide good context about the testnet's design and scale.


24-36: LGTM: Comprehensive software version information

The software details section clearly documents both the required versions and the custom features implemented in this testnet.


83-117: LGTM: Clear node setup instructions

The light node setup instructions are comprehensive and easy to follow, including both quick install and build from source options.


118-127: LGTM: Faucet information is clearly presented

The section includes all necessary instructions for obtaining and checking testnet tokens.


128-177: LGTM: Well-structured blob submission and retrieval instructions

The documentation provides clear, step-by-step instructions with example commands and expected outputs.


179-186: LGTM: Useful shortcut for common operations

The combined command for posting and retrieving blobs in one step is a helpful addition for users.


195-229: LGTM: Excellent UI documentation with screenshots

The UI documentation provides comprehensive coverage of all features with helpful screenshots that enhance understanding.

@jcstein jcstein merged commit 1d6da10 into main Apr 14, 2025
6 checks passed
@jcstein jcstein deleted the jcs/mammoth branch April 14, 2025 13:53
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.

3 participants