Skip to content

docs: appendix — divergence catalogue and gaps reconciled with the refactored specs - #129

Open
JarbasAl wants to merge 1 commit into
devfrom
docs/appendix-reconcile
Open

docs: appendix — divergence catalogue and gaps reconciled with the refactored specs#129
JarbasAl wants to merge 1 commit into
devfrom
docs/appendix-reconcile

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.

Brings the non-normative appendix in line with the refactored spec bodies. Re-verified against current origin/dev after the STOP-1/AUDIO-IN-1/session-1/MSG-1 landings.

divergences.md

  • §5.2: records the <skill_id>:common_query<skill_id>.common_query.request rename — the full-answer request is an addressed message, not a dispatch, so it moves off the colon shape MSG-1 §2.1.1 reserves for dispatch topics.
  • §5.4: records the TRANSFORM-1 priority-convention divergence — the reference implementation sorts descending (reverse=True), the exact inverse of the spec's ascending convention; inverse-convention assignments must be renumbered or the chain executes backwards.
  • §5.4: the STOP-1 "no escalation on silent poll" entry from the original draft is dropped. Current dev stop-1.md §4.1 step 5 still escalates to global_stop when no positive pong responder exists — the draft entry had this backwards, describing draft PR spec: stop-1.md — recency-targeted stop (no escalation on silence), RECOMMENDED timeouts, shared_pipeline_id defined #117's proposed (unmerged) behavior as if it were shipped. No real divergence is documented until spec: stop-1.md — recency-targeted stop (no escalation on silence), RECOMMENDED timeouts, shared_pipeline_id defined #117 lands.
  • Fixes a dangling PIPELINE-1 §9.4 citation for ovos.intent.unmatched to §9.3.
  • SESSION-1 field-registry cite corrected to §2.2 (was §2.1, stale after the session-1 refactor).

gaps.md

  • Drops the "per-plugin behavioural specs" gap — fallback, ocp, and persona now have their own specs (FALLBACK-1, OCP-1, PERSONA-1).
  • persona_id removed from the unclaimed-session-fields list (claimed by OVOS-PERSONA-1).
  • The bridge audio-over-bus gap is narrowed: outbound is covered by OVOS-AUDIO-1; AUDIO-IN-1 §1 explicitly scopes capture out of that spec, so satellite→hub inbound raw-audio transport is confirmed still undefined.
  • The managing-mode race entry is narrowed: BRIDGE-1 §3.4.2 already defines a MAY-fallback (inject using the last known session state); what's actually open is the queue-vs-drop policy for a second utterance arriving before the first round resolves.

patterns.md / reference.md

  • Fixes the nonexistent <owner_id>.converse.response citation to the real <skill_id>.converse.pong (CONVERSE-1 §4.2).

rationale.md / reference.md

  • Restores the "OVOS-MSG-1 v2 §2.1.1" section tag for the topic-naming-conventions citation (the topic-convention rule lives at §2.1.1, not the bare §2.1).

No appendix page describes SYSTEM_confirm/SYSTEM_select or the player time convention, so no reconciliation was needed there; the appendix banners (non-normative headers) are untouched. Non-normative — no CHANGELOG entry.

Merge order: this PR should merge last, after the normative spec-file wave (STOP-1 #117, AUDIO-IN-1, session-1, MSG-1 v2, etc.) — the catalogue exists to describe what those specs say, so it needs to land against their final, merged wording rather than in-flight drafts.

🤖 Generated with Claude Code

@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown

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: 0cc786e0-5d20-4f79-b9ce-d11d6d87787a

📥 Commits

Reviewing files that changed from the base of the PR and between 1d3622b and d90664e.

📒 Files selected for processing (5)
  • appendix/divergences.md
  • appendix/gaps.md
  • appendix/patterns.md
  • appendix/rationale.md
  • appendix/reference.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/appendix-reconcile

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.

@JarbasAl
JarbasAl marked this pull request as ready for review July 16, 2026 07:20
@JarbasAl
JarbasAl force-pushed the docs/appendix-reconcile branch from 0674d50 to 4fe20a8 Compare August 4, 2026 11:23
…factored specs

Squashed from:
- docs: appendix — reconciliation re-verified against dev; MSG-1 v2 §2.1.1 cites
- docs: cite the SESSION-1 field registry as §2.2
- docs: appendix — reconcile divergence catalogue and gaps with the refactored specs

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@JarbasAl
JarbasAl force-pushed the docs/appendix-reconcile branch from 4fe20a8 to d90664e 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