docs: add updated diagrams for node requirements and consensus node by jcstein · Pull Request #1674 · celestiaorg/docs

jcstein · 2024-08-20T21:02:20Z

Overview

Updates diagram for node requirements
1. Q: Should we take out the plain text version? I was thinking it could be useful for SEO purposes. But the duplication feels odd.
Updates consensus node diagram to say "consensus node" instead of "full consensus node"

Summary by CodeRabbit

Documentation
- Updated the image format in the consensus node documentation for improved clarity.
- Reintroduced a visual banner in the "Recommended Celestia node requirements" section to enhance user interface.
- Removed a commented-out image banner to improve the visual presentation.

coderabbitai · 2024-08-20T21:02:33Z

Walkthrough

The recent documentation updates enhance clarity and visual appeal in the Celestia node setup guides. Key modifications include changing image formats for consistency and refining visual elements. These enhancements focus on improving user experience and documentation accuracy, particularly concerning hardware requirements.

Changes

Files	Change Summary
nodes/...consensus-node.md	Updated image format from PNG to JPG for the consensus node illustration.
nodes/...overview.md	Reintroduced an image banner in the "Recommended Celestia node requirements" section, enhancing visual presentation.

Poem

🐇 In fields of data, I hop with glee,
New banners and images, oh what a sight to see!
With tweaks and updates, our docs shine bright,
Guiding our friends through day and night.
Celebrate changes, both big and small,
In the world of Celestia, we’ll conquer them all! 🌟

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.
- @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 as 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 resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

github-actions · 2024-08-20T21:03:39Z

PR Preview Action v1.4.7
🚀 Deployed preview to https://celestiaorg.github.io/docs-preview/./pr-1674/
on branch `main` at 2024-08-20 21:03 UTC

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e43bcd5 and 4cf5966.

Files ignored due to path filters (3)

public/img/node-requirements.jpg is excluded by !**/*.jpg
public/img/nodes/consensus-node.jpg is excluded by !**/*.jpg
public/img/nodes/full-consensus-node.png is excluded by !**/*.png

Files selected for processing (2)

nodes/consensus-node.md (1 hunks)
nodes/overview.md (1 hunks)

Files skipped from review due to trivial changes (2)

nodes/consensus-node.md
nodes/overview.md

cmwaters

Do consensus nodes really need 2TB? Do we make a distinction between pruned nodes and archival nodes?

jcstein · 2024-08-21T13:50:58Z

Do consensus nodes really need 2TB?

After discussing with @rootulp - we think 2 TB is a good recommendation for now, based on disk usage for different types of syncs that we tested which at maximum were over 1 TB. That being said, as you highlighted, this will always be a moving target. So maybe we can pick a safe value in the future like 10 TB?

Do we make a distinction between pruned nodes and archival nodes?

No, there is no distinction for this on node requirements. The pruning section briefly covers this though, do you think it needs revision for clarity?

rootulp

Q: Should we take out the plain text version? I was thinking it could be useful for SEO purposes. But the duplication feels odd.

The duplication feels like a maintenance burden. If we had to take out one of them, my preference would be to drop the image because the plaintext version is easier to edit.

Given the image was already created, I don't think we need to drop it for now. Ultimately defer to you.

jcstein · 2024-08-21T14:33:03Z

I'm also leaning toward removing the maintenance burden of this graphic, too, and keeping the plaintext version. Will revisit in a~~n hour or so~~ few minutes... Thanks for the feedback!

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4cf5966 and 3ceadbe.

Files ignored due to path filters (1)

public/img/node-requirements.jpg is excluded by !**/*.jpg

Files selected for processing (1)

nodes/overview.md (1 hunks)

Files skipped from review as they are similar to previous changes (1)

nodes/overview.md

jcstein added 2 commits August 20, 2024 16:59

docs: add node reqs

b018954

docs: add consensus node diagram updates

4cf5966

jcstein requested a review from rootulp August 20, 2024 21:02

jcstein self-assigned this Aug 20, 2024

coderabbitai bot reviewed Aug 20, 2024

View reviewed changes

cmwaters approved these changes Aug 21, 2024

View reviewed changes

rootulp approved these changes Aug 21, 2024

View reviewed changes

feat: remove node requirements image to reduce maintenance burdgen

3ceadbe

coderabbitai bot reviewed Aug 21, 2024

View reviewed changes

jcstein merged commit 9d529d0 into main Aug 21, 2024

jcstein deleted the jcs/update-nodereqs branch August 21, 2024 14:36

coderabbitai bot mentioned this pull request Sep 16, 2024

Document node's store structure #1603

Merged

coderabbitai bot mentioned this pull request Sep 27, 2024

docs: update BN/FN/LN requirements for shwap #1740

Closed

coderabbitai bot mentioned this pull request Oct 7, 2024

Update full-storage-node.md #1752

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add updated diagrams for node requirements and consensus node#1674

docs: add updated diagrams for node requirements and consensus node#1674
jcstein merged 3 commits intomainfrom
jcs/update-nodereqs

jcstein commented Aug 20, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Aug 20, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

github-actions bot commented Aug 20, 2024

Uh oh!

coderabbitai bot left a comment

Uh oh!

cmwaters left a comment •

edited

Loading

Uh oh!

jcstein commented Aug 21, 2024

Uh oh!

rootulp left a comment

Uh oh!

jcstein commented Aug 21, 2024 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

jcstein commented Aug 20, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Aug 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions bot commented Aug 20, 2024

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

cmwaters left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jcstein commented Aug 21, 2024

Uh oh!

rootulp left a comment

Choose a reason for hiding this comment

Uh oh!

jcstein commented Aug 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jcstein commented Aug 20, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 20, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

cmwaters left a comment •

edited

Loading

jcstein commented Aug 21, 2024 •

edited

Loading