docs(clp-s): Add skeleton for clp-s design documentation; Write first half of clp-s single-file archive design document.

[gibber9809]

Description

This PR begins adding developer design documentation for clp-s. It includes a very basic overview, a completely stubbed out background, and a halfway complete doc on the clp-s single-file archive format.

The documentation on the SFA format covers the archive format from the header through every metadata packet type. Detail on the "files" section will be added in a future PR.

Checklist

• [x] The PR satisfies the contribution guidelines.
• [x] This is a breaking change and that has been indicated in the PR title, OR this isn't a breaking change.
• [x] Necessary docs have been updated, OR no docs need to be updated.

Validation performed

• Built and served the docs and observed that docs appear to render correctly

Summary by CodeRabbit

• Documentation
  • Added new documentation for the compressed-log-processor-structured (clp-s) archive format, including an overview, background, and detailed single-file archive format specification.
  • Introduced a new entry for the clp-s design documentation in the developer guide, making it accessible alongside existing design documents.
  • Included warnings indicating that some sections are still under construction.

[coderabbitai[bot]]

Walkthrough

New documentation has been introduced for the "compressed-log-processor-structured" (clp-s) archive format. This includes an overview, background, and a detailed specification of the single-file archive format. The developer guide's table of contents is updated to reference this new section. The documentation is marked as under construction.

Changes

File(s)	Change Summary
docs/src/dev-guide/design-clp-structured/background.md	Added a background section for clp-s, referencing KV-IR and noting the section is under construction.
docs/src/dev-guide/design-clp-structured/index.md	Introduced clp-s, contrasted with KV-IR, provided links to background and archive format details.
docs/src/dev-guide/design-clp-structured/single-file-archive-format.md	Added detailed specification for clp-s single-file archive format v0.3.1, including header, metadata, and files sections.
docs/src/dev-guide/index.md	Updated developer guide TOC to include the new clp-s design documentation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DocsIndex
    participant CLPSIndex
    participant Background
    participant ArchiveFormat

    User->>DocsIndex: Access developer guide index
    DocsIndex->>CLPSIndex: Navigate to clp-s design section
    CLPSIndex->>Background: Optionally view background
    CLPSIndex->>ArchiveFormat: Optionally view archive format specification

Possibly related PRs

• y-scope/clp#833: Adds background documentation for the KV-IR streaming compression format, which complements the clp-s background introduced here.

---

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

• 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>, please review it.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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.

[gibber9809]

Yeah I did sneak in an expansion of the MPT acronym on first use, but I think for this doc I'll leave explanation for the MPT-specific section later in the doc.

For the extra whitespace I decided to ignore rabbit on that one since the ::::{card} that all of the figures are in already give enough space.