Skip to content

docs: refresh glossary hazard count + roadmap.md to 2026-07-15 - #537

Merged
jensholdgaard merged 3 commits into
mainfrom
docs/glossary-roadmap-refresh
Jul 15, 2026
Merged

docs: refresh glossary hazard count + roadmap.md to 2026-07-15#537
jensholdgaard merged 3 commits into
mainfrom
docs/glossary-roadmap-refresh

Conversation

@jensholdgaard

@jensholdgaard jensholdgaard commented Jul 15, 2026

Copy link
Copy Markdown
Owner

What

Two small doc fixes flagged by an earlier gap audit, split out from code-change PRs per convention:

  • docs/glossary.md: "seven current hazards" → "eight" (H8, replication-induced dedup under clock drift, was added after this line was last touched).
  • docs/roadmap.md: §3's "current state" and RFC ladder hadn't been refreshed since 2026-06-15 (stopped at RFC 0013). Twenty RFCs (0014-0033) landed since and went unlisted. §5's deferred-capabilities table still framed WAL, the OTLP wire endpoints, the query DSL, auth+tenant binding, and the server binary/Helm chart as future work — all have shipped as part of the post-MVP shipping milestone. Only the Perses datasource plugin is still genuinely deferred. Rewrote the RFC ladder table, the "what remains" paragraph, and §5's table to reflect actual status, each cross-checked against the individual RFC files' own frontmatter status: field rather than assumed from memory.

Note: RFC 0031's own frontmatter still reads status: red despite substantial progress (most comparative classes frozen/gate-enforcing); flagged in the roadmap table rather than silently corrected, since that RFC is still mid-flight (PR #536) and its status update belongs with that close-out, not this doc-only PR.

Checks run

mdbook build — clean, no new warnings.

🤖 Generated with Claude Code

https://claude.ai/code/session_01WQY9wfrfRggqSpMLH8Xj3Y

Summary by CodeRabbit

  • Documentation
    • Updated the glossary to reflect that eight hazards are currently catalogued.
    • Refreshed the roadmap with July 2026 status information, updated RFC outcomes, revised crate descriptions, and current open and deferred work.

glossary.md still said "seven current hazards" — hazards.md has had
eight (H1-H8) since H8 (replication-induced dedup under clock drift)
landed.

roadmap.md's "current state" hadn't been refreshed since 2026-06-15
and stopped at RFC 0013; twenty RFCs (0014-0033) since then went
unlisted, and §5's deferred-capabilities table still framed WAL, the
OTLP wire endpoints, the query DSL, auth, and the server binary/Helm
chart as future work when all of them have shipped as part of the
post-MVP milestone. Only the Perses datasource plugin is still
genuinely deferred. Rewrote §3's RFC ladder through 0033, the
"what remains" paragraph, and §5's table to reflect actual status.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WQY9wfrfRggqSpMLH8Xj3Y
@jensholdgaard
jensholdgaard requested a review from Copilot July 15, 2026 21:38
@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@jensholdgaard, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 5 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: c09e941a-2f4b-48b5-abda-214abbc478a2

📥 Commits

Reviewing files that changed from the base of the PR and between 880f3e5 and 0661b4f.

📒 Files selected for processing (1)
  • docs/roadmap.md
📝 Walkthrough

Walkthrough

Documentation updates correct the glossary hazard count and refresh the roadmap with July 2026 dates, RFC outcomes, crate descriptions, remaining work, and deferred MVP capability statuses.

Changes

Glossary update

Layer / File(s) Summary
Hazard count correction
docs/glossary.md
The “Hazard” definition now states that eight hazards are catalogued.

Roadmap refresh

Layer / File(s) Summary
Roadmap status and deferred work
docs/roadmap.md
The roadmap date, RFC ladder, crate summaries, open work, and deferred MVP capability statuses are updated for the July 2026 state.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately summarizes the docs-only glossary and roadmap refresh.
Description check ✅ Passed The description explains the doc changes, rationale, and validation result, though it omits the template's Summary/Related/Checklist headings.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/glossary-roadmap-refresh

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/roadmap.md`:
- Line 331: Update the stale OTLP scope note in the roadmap to reflect that the
gRPC and HTTP wire listeners are already landed, removing the contradictory
post-MVP wording while preserving any still-applicable scope details.
- Around line 5-13: Reconcile the roadmap summary with the eight-row §5
deferred-capabilities table: update the “six of seven” count and named shipped
capabilities in docs/roadmap.md lines 5-13 to reflect the table’s actual
statuses, and revise docs/roadmap.md lines 196-200 so it does not claim every §5
capability except Perses is complete, since multi-tenancy remains only partially
landed.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 2e0fe561-2c88-4f16-9b5e-3cce0c8b9eae

📥 Commits

Reviewing files that changed from the base of the PR and between 44c292e and 880f3e5.

📒 Files selected for processing (2)
  • docs/glossary.md
  • docs/roadmap.md

Comment thread docs/roadmap.md Outdated
Comment thread docs/roadmap.md

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Doc-only refresh to keep project documentation aligned with the current post-MVP shipping state: hazard catalog count in the glossary and the roadmap’s “current state”/RFC ladder and deferred-capabilities section.

Changes:

  • Update glossary hazard count from seven → eight.
  • Refresh docs/roadmap.md “Last updated”, current-state date, RFC ladder entries through RFC 0033, and the deferred-capabilities table to reflect shipped items.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
docs/roadmap.md Updates the roadmap’s current-state snapshot, RFC ladder, and deferred-capabilities section to reflect post-MVP progress.
docs/glossary.md Fixes the stated count of current hazards to match docs/hazards.md.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/roadmap.md Outdated
Comment thread docs/roadmap.md Outdated
Comment thread docs/roadmap.md
jensholdgaard and others added 2 commits July 16, 2026 00:32
Both reviewers on #537 caught real mismatches:

- The banner and §5 intro said "six of seven" rows shipped; the table
  actually has eight rows (six landed, one partially landed, one still
  deferred), and the banner listed "auth + tenant binding" and
  "object storage on S3" as if they were §5 rows — neither is; the
  actual row is "multi-tenancy at runtime," and it's only partially
  landed, not fully.
- The "Note on OTLP scope" paragraph still said the wire endpoints
  "remain post-MVP" even though the table two paragraphs up now marks
  them Landed — contradictory as written.
- The RFC ladder skipped RFC 0012 (meta: CLAUDE.md wording, accepted),
  breaking the claimed 0001-0033 contiguous coverage.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WQY9wfrfRggqSpMLH8Xj3Y

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@jensholdgaard
jensholdgaard merged commit c30986a into main Jul 15, 2026
26 checks passed
@jensholdgaard
jensholdgaard deleted the docs/glossary-roadmap-refresh branch July 15, 2026 23:40
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.

2 participants