Add CLAUDE.md for Claude Code guidance#24
Conversation
Documents the DBN delegation boundary, the two clients, Live typed/untyped modes, the TCP read stack, the reconnect supervisor design, and multi-schema capture durability — plus test/build/benchmark/docs commands and the DATABENTO_LIVE_TESTS gating. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: e1a338315b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| julia --project=benchmark benchmark/runbench.jl --tiers=small # override size tiers | ||
|
|
||
| # Docs (Documenter.jl) | ||
| julia --project=docs docs/make.jl |
There was a problem hiding this comment.
In a fresh checkout this command cannot build the docs as documented: docs/make.jl immediately imports Documenter and DatabentoAPI, but docs/Project.toml has no manifest or local [sources] entry and this command never instantiates the docs environment or develops the repository package into it. The existing documentation workflow explicitly performs Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate() first in .github/workflows/documentation.yml:30-34. Include that preparation step in this guidance so future sessions can run the advertised docs build successfully.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Good catch — fixed in 1dc47dd. The docs section now runs the env-setup step from documentation.yml before building:
julia --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
julia --project=docs docs/make.jl
Codex review flagged that 'julia --project=docs docs/make.jl' fails on a fresh checkout — docs/Project.toml has no manifest and the repo package isn't developed into it. Add the Pkg.develop + Pkg.instantiate step that .github/workflows/documentation.yml runs first. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 participant
Summary
Adds a
CLAUDE.mdat the repo root to orient future Claude Code sessions. Based on latestmain(post #22/#23).Covers, repo-specifically (no generic boilerplate):
benchmark/anddocs/projects, and theDATABENTO_LIVE_TESTS=1gating + mock-gateway/mock-dispatcher test design.Historical/Liveclients;Livetyped vs untyped modes; the TCP read stack (CountingIO→BufferedReader→DBNDecoder); the reconnect supervisor (channel-ownership-by-policy, immediate-then-backoff schedule, replay-on-reconnect, terminal errors); and single-connection multi-schema capture + zstd-frame durability.🤖 Generated with Claude Code