Repository navigation
docs: explain read completeness contract - #3
Merged
Merged
Conversation
marcomc
force-pushed
the
docs/read-completeness
branch
from
September 13, 2026 13:09
8a47abb to
a11ea43
Compare
marcomc
marked this pull request as ready for review
September 13, 2026 13:09
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Dependency
This documentation describes the public read API introduced by #2. Keep this PR as a draft until that dependency is merged into
release/0.3.0; it is intentionally suitable for inclusion with a later, narrower implementation PR.Validation
uv run ruff check .uv run ruff format --check .markdownlint --config /Users/mmassari/.markdownlint.json README.md docs/read-completeness.mdgit diff --check