docs: add vacuum! spec

[evan-forbes]

Overview

creating a PR for the vacuum spec.

rendered

[github-actions[bot]]

PR Preview Action v1.4.8 :---: :rocket: Deployed preview to https://celestiaorg.github.io/celestia-app/pr-preview/pr-3990/ on branch gh-pages at 2024-10-18 03:30 UTC

[coderabbitai[bot]]

📝 Walkthrough

## Walkthrough The changes include modifications to the `.markdownlint.yaml` configuration file, disabling certain Markdown linting rules and adjusting others. A new entry for "Vacuum!" has been added to the `specs/src/SUMMARY.md` file, linking to a newly created `vacuum.md` document. This document details the Vacuum! protocol for efficient blob propagation, including its architecture, message types, and operational logic. ## Changes | File | Change Summary | |--------------------------------|------------------------------------------------------------------------------------------------| | `.markdownlint.yaml` | - Disabled rules: `MD010`, `MD013`, `MD033`
- Added rule: `MD024: false`
- Modified rule: `MD055` to use style `leading_and_trailing` | | `specs/src/SUMMARY.md` | - Added new entry: `[Vacuum!](./vacuum.md)` under "Consensus" section | | `specs/src/vacuum.md` | - Introduced specification for the Vacuum! protocol, detailing architecture, message types, and logic for blob propagation. Added multiple new message types and methods. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant MarkdownLinter participant Summary participant VacuumProtocol User->>MarkdownLinter: Submit Markdown file MarkdownLinter->>MarkdownLinter: Check rules (MD010, MD013, MD033) MarkdownLinter->>User: Return linting results User->>Summary: View specifications Summary->>VacuumProtocol: Access Vacuum! protocol details VacuumProtocol->>User: Provide protocol specifications ```

---

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): > ‼️ **IMPORTANT** > Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged. - 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. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[evan-forbes]

TBH I don't think the vacuum spec should be added to the specs yet because vaccum isn't implemented or used.

fair! this is for the upcoming blog post. folks suggested it was better to have this up on github instead of hackmd

[evan-forbes]

converted to a draft for now, and we can leave it here until we are confident the implementation and spec match

I think github is better for reviewing this than hackmd to perhaps keep more context and link to ther issues