spec: GLOSSARY.md — topic-shape, stop-targeting, and shared_pipeline_id entries - #127
Merged
Conversation
📝 WalkthroughWalkthroughGLOSSARY.md replaces “Capture map” with “Slot map”, adds ChangesGlossary terminology
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
JarbasAl
marked this pull request as ready for review
July 16, 2026 07:20
JarbasAl
force-pushed
the
spec/glossary-terms
branch
from
August 4, 2026 11:37
a0d5016 to
4bec3be
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
GLOSSARY.md (1)
39-40: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winClarify the two dispatch topic entries.
Dispatch-shaped topicandDispatch topiccurrently describe the same colon-bearing<skill_id>:<intent_name>address. DefineDispatch-shaped topicas the syntax category andDispatch topicas the concrete MSG-1 term, or cross-reference one entry from the other.Also applies to: 69-69
🤖 Prompt for 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. In `@GLOSSARY.md` around lines 39 - 40, Clarify the glossary distinction between “Dispatch-shaped topic” and “Dispatch topic”: define the former as the general colon-bearing syntax category, and define the latter as the concrete MSG-1 term for a valid <skill_id>:<intent_name> address, or cross-reference the entries while avoiding duplicate definitions.
🤖 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 `@GLOSSARY.md`:
- Line 64: Update the “Transformer chain” glossary definition to state that
transformers run unconditionally except when utterance cancellation permits the
chain to stop early, keeping the wording aligned with the cancellation exception
defined in transformer.md.
- Line 62: Clarify the pipeline_id definition in GLOSSARY.md so the allowed
character constraint is unambiguous: specify that multi-character IDs are valid
and require one or more characters from [A-Za-z0-9_-], or explicitly state the
per-character rule. Preserve the existing exclusions of “:” and “.” and the
reference to the orchestrator’s loaded-plugin set.
---
Nitpick comments:
In `@GLOSSARY.md`:
- Around line 39-40: Clarify the glossary distinction between “Dispatch-shaped
topic” and “Dispatch topic”: define the former as the general colon-bearing
syntax category, and define the latter as the concrete MSG-1 term for a valid
<skill_id>:<intent_name> address, or cross-reference the entries while avoiding
duplicate definitions.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| | **Fallback pipeline plugin** | A pipeline plugin that maintains a registry of fallback skills and queries them in order until one claims the utterance ([FALLBACK-1 §2](fallback.md)). | | ||
| | **Match** | The object a pipeline plugin's `match` function returns to claim an utterance — `skill_id`, `intent_name`, `lang`, `slots`, `utterance`, and optionally `updated_session` ([PIPELINE-1 §4.1](pipeline-1.md)). | | ||
| | **Pipeline plugin** | A component occupying a stage in `session.pipeline`, identified by an opaque `pipeline_id`, that may claim an utterance via `match` ([PIPELINE-1 §3](pipeline-1.md)). | | ||
| | **`pipeline_id`** | The opaque string matching `[A-Za-z0-9_-]` — no `:`, no `.` — that keys a pipeline plugin instance in the orchestrator's loaded-plugin set ([PIPELINE-1 §3](pipeline-1.md)). | |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Make the pipeline_id constraint unambiguous.
[A-Za-z0-9_-] is a single-character regex class. If multi-character IDs are valid, use [A-Za-z0-9_-]+ or state that every character must belong to the class. The current wording can make valid IDs appear invalid.
🤖 Prompt for 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.
In `@GLOSSARY.md` at line 62, Clarify the pipeline_id definition in GLOSSARY.md so
the allowed character constraint is unambiguous: specify that multi-character
IDs are valid and require one or more characters from [A-Za-z0-9_-], or
explicitly state the per-character rule. Preserve the existing exclusions of “:”
and “.” and the reference to the orchestrator’s loaded-plugin set.
| | **Pipeline plugin** | A component occupying a stage in `session.pipeline`, identified by an opaque `pipeline_id`, that may claim an utterance via `match` ([PIPELINE-1 §3](pipeline-1.md)). | | ||
| | **`pipeline_id`** | The opaque string matching `[A-Za-z0-9_-]` — no `:`, no `.` — that keys a pipeline plugin instance in the orchestrator's loaded-plugin set ([PIPELINE-1 §3](pipeline-1.md)). | | ||
| | **Transformer** | A black-box component that consumes one artifact at a fixed point in the utterance lifecycle and produces an artifact of the same shape for the next stage ([TRANSFORM-1 §1](transformer.md)). | | ||
| | **Transformer chain** | An ordered set of transformers of one type that all run, unconditionally, when their injection point is reached — no claim, no first-result-wins ([TRANSFORM-1 §1](transformer.md)). | |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Include the transformer cancellation exception.
Line 64 says all transformers run unconditionally. transformer.md:41-58 states that utterance cancellation is an exception to the no-early-exit rule. Add this exception to keep the glossary aligned with the referenced specification.
🤖 Prompt for 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.
In `@GLOSSARY.md` at line 64, Update the “Transformer chain” glossary definition
to state that transformers run unconditionally except when utterance
cancellation permits the chain to stop early, keeping the wording aligned with
the cancellation exception defined in transformer.md.
…id entries Squashed from: - spec: GLOSSARY.md — rows aligned with MSG-1/PIPELINE-1 audit wording - spec: GLOSSARY.md — coined-term rows for INTENT-4, FALLBACK-1, PIPELINE-1, TRANSFORM-1, MSG-1, PERSONA-1, OCP-1 - spec: GLOSSARY.md — dispatch-shaped vs dotted addressed topic, recency-targeted stop, <shared_pipeline_id> Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
JarbasAl
force-pushed
the
spec/glossary-terms
branch
from
August 4, 2026 12:51
1c254dd to
de9b176
Compare
JarbasAl
marked this pull request as draft
August 10, 2026 14:25
JarbasAl
marked this pull request as ready for review
August 10, 2026 18:31
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.
Category: editorial —
GLOSSARY.mdWhat
Adds glossary entries for topic shape, stop targeting, and
shared_pipeline_id.Why (defect citation)
Three terms are used normatively across MSG-1, STOP-1 and PIPELINE-1 and had no glossary entry. Definitional only — the normative homes are the specs.
Semantic change?
No. Zero semantic change — rubber-stamp.
Owner decision needed?
No.
Depends on
spec/stop-1definesshared_pipeline_id(§5.2); merge that first so the glossary entry points at real text.No
version:field bump and no CHANGELOG entry: the specs are unreleased and all one version.