Skip to content

docs: regenerate diagrams for log indexes - #508

Merged
vishr merged 2 commits into
mainfrom
docs/format6-diagrams
Nov 21, 2026
Merged

vishr merged 2 commits into
mainfrom
docs/format6-diagrams

Conversation

@vishr

@vishr vishr commented Nov 21, 2026 •

Copy link
Copy Markdown
Member

Batch format 6 (#507) added logs.fidx, but the diagram SVGs were not regenerated. This renders them with archify 3.1.0 and moves the persistence diagram's evidence pin to main after #507. That re-resolves its citations: Duck moved to internal/engine, and line numbers shifted. The trace read now cites both index lookups.

Summary by CodeRabbit

  • Documentation
    • Updated the persistence diagram to reflect current source references for data ingestion, storage, indexing, querying, and maintenance.

…dexes

The persistence diagram now pins main after batch format 6, so its citations
move with the code: Duck moved to internal/engine and the trace read cites
both index lookups.
@coderabbitai

coderabbitai Bot commented Nov 21, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

Changes: Persistence diagram

Layer / File(s) Summary
Refresh persistence diagram references
docs/diagrams/persistence.json
The diagram uses a new repository revision and updated source line references. DuckDB SQL, maintenance, and rollup references point to internal/engine/duck.go.

Change: Other

Merge Risk: Minimal · up to a88d7

This updates the references in the persistence diagram to the current source locations. It has no runtime effect and is safe to merge.

Architecture risk: Low · up to a88d7

The change affects 1 system.

Changed systems: docs

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/diagrams/persistence.json: The repository revision changes from 681d46ba8cf0a92ea85764bfa4736a8e2739a8c9 to d6f7c969846f841495b9ff965a75c5b0aff8742f.
  • observed — Modified behavior in docs/diagrams/persistence.json: The OTLP request source reference moves from server.go lines 54–60 to lines 58–65.
  • observed — Modified behavior in docs/diagrams/persistence.json: The commit-worker source reference moves from writer.go lines 143–150 to lines 262–272.
  • observed — Modified behavior in docs/diagrams/persistence.json: The durable-publish references in parquet.go change to lines 316–339, 1430, and 390–427, replacing references to lines 194–217, 282, and 308–345.
Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 17992151-eb1a-4666-871c-220df987624a
Commits

Reviewing files that changed from the base of the PR and between d6f7c96 and a88d705.

Files ignored due to path filters: 4

  • docs/diagrams/architecture.svg is excluded by !**/*.svg
  • docs/diagrams/persistence.svg is excluded by !**/*.svg
  • site/public/diagrams/architecture.svg is excluded by !**/*.svg
  • site/public/diagrams/persistence.svg is excluded by !**/*.svg
Files selected for processing: 1

  • docs/diagrams/persistence.json

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 8 remain after this review.

@vishr
vishr enabled auto-merge November 21, 2026 06:32
@vishr
vishr added this pull request to the merge queue Nov 21, 2026
Merged via the queue into main with commit 0a21b9e Nov 21, 2026
33 checks passed
@vishr
vishr deleted the docs/format6-diagrams branch November 21, 2026 06:48
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.

1 participant