Skip to content

spec: README.md — spec-index titles match the spec headers - #128

Open
JarbasAl wants to merge 1 commit into
devfrom
spec/readme-index
Open

spec: README.md — spec-index titles match the spec headers#128
JarbasAl wants to merge 1 commit into
devfrom
spec/readme-index

Conversation

@JarbasAl

@JarbasAl JarbasAl commented Jul 4, 2026

Copy link
Copy Markdown
Member

🤖 Auto-generated by Claude Fable 5 (claude-fable-5) via Claude Code — NOT human-reviewed. Verify before acting. Cross-spec citations were model-verified against dev source; behavior-change sections need owner judgment.

Aligns the README spec index with each spec file's own header title (the index drops the trailing "Specification" by convention):

  • OVOS-SESSION-1 — "Session Carrier Wire Shape" → "Session" (session-1.md is the Session Specification).
  • OVOS-INTENT-4 — "Intent and Entity Registration" → "Intent and Entity Registration Bus Contract" (the file's full header title).

Follow-up commit: the index Version column was also re-checked against every spec header on the rebased tree. OVOS-MSG-1, OVOS-TRANSFORM-1, and OVOS-OCP-1 had shipped as Version 2 but the index still listed 1 — bumped all three to 2 to match. All other rows re-verified clean.

Not fixed here (out of scope; each lands in its own per-file PR): the stale in-body citation "Session Carrier Wire Shape Specification" for OVOS-SESSION-1 still appears in persona.md, common-query.md, fallback.md, session-2.md, intent-context.md, and converse.md, plus the CHANGELOG.md section heading.

Non-normative — no CHANGELOG entry.

Merge order: this PR should merge BEFORE #54 (user-id-1) — #54 touches adjacent lines in the same README index table and its own description notes the README conflict should resolve by merging this PR first.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the README specification index with renamed documentation and revised links.
    • Updated listed specification versions for messaging, sessions, transformations, and OCP.

@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

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

Next review available in: 36 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

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: cac60a49-ea8b-43eb-9e87-b001194a6b49

📥 Commits

Reviewing files that changed from the base of the PR and between f73c58d and 9a71e25.

📒 Files selected for processing (1)
  • README.md
📝 Walkthrough

Walkthrough

The README specification index updates the INTENT-4 title, MSG-1 and SESSION-1 references, and the compatibility versions for TRANSFORM-1 and OCP-1.

Changes

Specification index

Layer / File(s) Summary
Update specification index entries
README.md
The index updates the INTENT-4 title, MSG-1 and SESSION-1 entries, and raises the TRANSFORM-1 and OCP-1 compatibility versions from 1 to 2.

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the README spec-index title alignment, which is a primary change in the pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch spec/readme-index

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.

Squashed from:
- spec: README.md — index versions match spec headers (MSG-1, TRANSFORM-1, OCP-1 at 2)
- spec: README.md — align the spec index with the spec headers (SESSION-1, INTENT-4 titles)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@JarbasAl
JarbasAl force-pushed the spec/readme-index branch from f73c58d to 9a71e25 Compare August 4, 2026 12:51
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