docs: Add Chain Operator Feature: Span Batches

[richardgreg]

Description

1. Documentation for Span Batches:

   • Overview of what span batches are and their benefits.
   • Detailed instructions on how to enable span batches in the chain configuration.

2. Configuration Instructions:

   • Clear steps to add or update the configuration settings to enable span batches.
   • Instructions on redeploying the chain node and verifying the changes.

3. Links to Related Pages:

   • Direct links to detailed span batches specification and design documents for further reading.

Tests

Please describe any tests you've added. If you've added no tests, or left important behavior untested, please explain why not.

Additional context

Add any other context about the problem you're solving.

Metadata

• Fixes #725

[coderabbitai[bot]]

Walkthrough

The recent changes introduce a new feature, "span batches," into the chain operator documentation. This enhancement allows users to utilize span batches within their chain configurations. The documentation now includes a dedicated guide detailing how to enable span batches, configure settings, and verify their activation, ensuring users can effectively implement this feature in their operations.

Changes

File(s)	Change Summary
pages/builders/chain-operators/features/_meta.json, pages/builders/chain-operators/features/span-batches.mdx	Added documentation for "span batches," including a new entry in _meta.json and a comprehensive guide in span-batches.mdx.
words.txt	Removed the entry blockheaders from the list of terms.

Assessment against linked issues

Objective	Addressed	Explanation
Document span batches and instructions on enabling them (##725)	✅

---

Recent review details

Configuration used: .coderabbit.yaml Review profile: CHILL

Commits

Files that changed from the base of the PR and between 78c0d5f97e89183523a32fc3d4fb65441bc540a2 and 8ff6f85efca92e4c911dc39373106deb0255a512.

Files selected for processing (1)

• pages/builders/chain-operators/features/_meta.json (1 hunks)

Additional comments not posted (1)

pages/builders/chain-operators/features/_meta.json (1)

5-5: LGTM!

The new key-value pair is correctly formatted and follows the existing structure of the JSON file. The description is clear and concise.

The code changes are approved.

---

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
• Mastodon
• Reddit
• LinkedIn

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.

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.

[netlify[bot]]

✅ Deploy Preview for docs-optimism ready!

Name	Link
🔨 Latest commit	8ff6f85efca92e4c911dc39373106deb0255a512
🔍 Latest deploy log	https://app.netlify.com/sites/docs-optimism/deploys/66cdcee01309100008718a97
😎 Deploy Preview	https://deploy-preview-823--docs-optimism.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[richardgreg]

Thanks 🙏