Skip to content
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

Typo Update retrievability.md #1785

Merged
merged 1 commit into from
Nov 7, 2024
Merged

Typo Update retrievability.md #1785

merged 1 commit into from
Nov 7, 2024

Conversation

0xwitty
Copy link
Contributor

@0xwitty 0xwitty commented Nov 7, 2024

Overview

The word "historic" is correct, but the more common usage is "historical" when referring to data or events in the past.
So, "historic blocks" corrected to "historical blocks" for consistency.

Summary by CodeRabbit

  • Documentation
    • Enhanced clarity on data retrievability and pruning practices.
    • Introduced a light node sampling window of 30 days for improved data management.
    • Refined guidance on accessing historical data for rollups, emphasizing alternative methods.
    • Discussed future enhancements like namespace pinning for selective data storage.

"historic blocks" should corrected to "historical blocks" for consistency.
Copy link
Contributor

coderabbitai bot commented Nov 7, 2024

Walkthrough

The pull request modifies the learn/retrievability.md document to improve clarity and detail on data retrievability and pruning practices in Celestia. Key updates include the introduction of a 30-day light node sampling window, which specifies that light nodes will prune data blobs older than this period while still allowing queries from archival nodes. The document also refines suggested practices for rollups, advising against sole reliance on the GetAll API for accessing historical data and proposing alternative methods for data retrieval.

Changes

File Change Summary
learn/retrievability.md - Updated introduction to clarify purpose of data availability layers.
- Introduced a 30-day sampling window for light nodes effective from version v0.13.0.
- Clarified that light nodes will prune data blobs older than 30 days by default.
- Refined practices for rollups, advising against reliance on the GetAll API.
- Proposed alternatives for accessing historical data and mentioned future enhancements.

Possibly related PRs

  • docs: update quickstart #1766: The changes in the quick start guide enhance clarity and organization, which aligns with the main PR's focus on improving the documentation regarding data retrievability and pruning practices.
  • chore: Fix typos in documentation for multiple files #1780: This PR addresses typographical errors across multiple documentation files, which may include relevant sections on data management practices similar to those discussed in the main PR.
  • Typo corrections #1782: This PR corrects typographical errors in various tutorial files, potentially improving the clarity of documentation related to data handling and retrieval, which is a key focus of the main PR.

Suggested reviewers

  • jcstein

🐰 In the land of Celestia, where data flows bright,
A 30-day window brings clarity and light.
With nodes that are light, and practices new,
We prune and we query, with methods so true.
So hop along, friends, let’s share and explore,
For data retrievability opens the door! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 629e9cc and 62b4f72.

📒 Files selected for processing (1)
  • learn/retrievability.md (1 hunks)
🔇 Additional comments (1)
learn/retrievability.md (1)

45-45: LGTM! Terminology is consistent.

The use of "historical blocks" is appropriate in this context, as it's the more commonly used term when discussing data or events from the past.


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

@jcstein jcstein merged commit 138e7c3 into celestiaorg:main Nov 7, 2024
2 checks passed
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.

2 participants