Skip to content

docs(deployment): stop recommending START_WRITERS=false for readers#688

Open
djwhitt wants to merge 1 commit intodevelopfrom
docs-start-writers-recommendation
Open

docs(deployment): stop recommending START_WRITERS=false for readers#688
djwhitt wants to merge 1 commit intodevelopfrom
docs-start-writers-recommendation

Conversation

@djwhitt
Copy link
Copy Markdown
Collaborator

@djwhitt djwhitt commented Apr 24, 2026

Summary

  • Remove START_WRITERS=false from the shared-ClickHouse reader recommendation in docs/deployment-topologies.md.
  • START_WRITERS also gates the chain index (blocks, L1 transactions, bundle membership, data-item → root-TX mappings, offsets), which data retrieval paths like /raw, /ar, and /tx/:id depend on — not just GraphQL.
  • Reframe §2 so shared ClickHouse scales GraphQL query capacity; readers keep writers enabled and accept duplicated ingest locally.

Test plan

  • Render docs/deployment-topologies.md on GitHub and confirm §2 diagram and notes read correctly.

🤖 Generated with Claude Code

Shared-ClickHouse reader gateways should keep writers enabled. START_WRITERS
also gates the chain index (blocks, L1 transactions, bundle membership,
data-item → root-TX mappings, offsets), which data retrieval paths like
/raw, /ar, and /tx/:id rely on — not just GraphQL. Reframe topology §2 so
shared ClickHouse scales GraphQL query capacity rather than replacing
local SQLite indexing.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 24, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: f943fc88-6d3b-4a72-8283-47a2b1980f95

📥 Commits

Reviewing files that changed from the base of the PR and between cb16b16 and 5bb23fb.

📒 Files selected for processing (1)
  • docs/deployment-topologies.md

📝 Walkthrough

Walkthrough

Documentation update to Topology 2 clarifies that readers should keep writers enabled by default. Removes the START_WRITERS=false configuration recommendation, simplifies flowchart labels, and revises the "When to use" section and notes to explain that START_WRITERS controls chain-index data required by multiple retrieval endpoints, with shared ClickHouse handling query capacity.

Changes

Cohort / File(s) Summary
Topology 2 Documentation
docs/deployment-topologies.md
Updated reader-only mode guidance by removing START_WRITERS=false recommendation, clarifying that writers should remain enabled (default). Simplified reader gateway flowchart labels to show only CLICKHOUSE_URL=cluster. Rewrote "When to use" section to clarify readers rely on shared ClickHouse for /graphql responses while indexing locally. Replaced notes about composite-boundary height gaps with explanation of START_WRITERS controlling chain-index data and shared ClickHouse serving as query capacity with duplicated ingestion.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title directly and accurately describes the main change: removing START_WRITERS=false from reader configuration recommendations in deployment documentation.
Description check ✅ Passed The description is directly related to the changeset, explaining the rationale for removing START_WRITERS=false, clarifying chain index dependencies, and reframing the topology section.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-start-writers-recommendation

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.16%. Comparing base (9795c14) to head (5bb23fb).
⚠️ Report is 5 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #688      +/-   ##
===========================================
- Coverage    77.18%   77.16%   -0.02%     
===========================================
  Files          117      117              
  Lines        40824    40824              
  Branches      3042     3041       -1     
===========================================
- Hits         31509    31502       -7     
- Misses        9275     9282       +7     
  Partials        40       40              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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