spec: editorial fixes, cross-reference, glossary and timeless wording - #225
Draft
JarbasAl wants to merge 1 commit into
Draft
spec: editorial fixes, cross-reference, glossary and timeless wording#225JarbasAl wants to merge 1 commit into
JarbasAl wants to merge 1 commit into
Conversation
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: trueThanks 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 |
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
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.
Eight editorial fixes to the specification corpus, no normative changes.
Broken cross-reference in intent-4.md §10. Before: "...is defined in OVOS-BRIDGE-1 §4.4." After: "...is defined in OVOS-BRIDGE-1 §4.3." BRIDGE-1's §4 tree ends at §4.3, and §4.3's "Reconnect" paragraph is exactly the satellite-registration recovery path the sentence describes.
Normative label mismatch in gui-1.md. Before: the "Interactive companions — reserved for a future version" section opened "Non-normative in this version." while still stating "Producers MUST NOT emit them in this version". After: the section is retitled "Interactive companions — reserved names", the non-normative label is dropped, and the prohibition reads "Producers MUST NOT emit them" with "in this version" removed, since a capitalized prohibition is a normative rule.
Compatibility/history wording removed from three spec bodies. ocp-1.md §4.3 before: "The player's legacy listener and TTS aliases are pre-spec compatibility surface and are not part of this table." After: "Listener and TTS aliases the player may also expose are not part of this table." intent-3.md before: "One legacy engine historically treated an inline
#as a wildcard for a single digit character; templates must not rely on that behavior." After: "An inline#is not a wildcard for a single digit character; templates must not rely on that behavior." gui-1.md §3.1 before: "...grows only by amendment of this specification (a new version under the repository's versioning policy)." After: "...grows only by amendment of this specification, under the versioning policy this corpus states (VERSIONING.md)."Three glossary entries added for terms with their own spec subsection but missing from GLOSSARY.md: "Contest identifier" (COMMON-QUERY-1 §6.4), "Candidate poll" (PIPELINE-1 §4.5), "Willingness contest" (FALLBACK-1 §6.1), each one sentence pointing at the defining section, in the glossary's existing format.
session-1.md §3.3
site_id. Added one clause stating the grouping the field expresses: "an opaque group identifier expressing which devices are co-located at one physical place — a room or site — sharing the samesite_idvalue." No normative text changed; a reader searching for "room" now finds the field.Two more dangling cross-references found on dev. converse.md's dispatch-exclusion list before: "define the wire shape of an interrupt signal — owned by OVOS-STOP-1 (§5.4);" After: "...(§5.3);" — STOP-1 §5 ends at §5.3 ("Broadcast"), which defines the
ovos.stopemission the sentence means; STOP-1 has no §5.4. pipeline-1.md §5.6 before: "...a layer-2 substrate (per OVOS-MSG-1 §3.4 / §4.4) needs to express granular per-peer permissions..." After: "...§3.4 / §4.2..." — MSG-1 §4 has only §4.1 and §4.2; §4.2 ("The layer-2 picture") is the section the sentence relies on.Stale rationale in common-query.md §8 filtering list. Before: "honour the live
session.blacklisted_skillsitself (§8 step 2) — the PIPELINE-1 §5.3 orchestrator backstop cannot see the answering skill, becauseMatch.skill_idis the plugin'spipeline_id;" After: "honour the livesession.blacklisted_skillsitself (§8 step 2) — PIPELINE-1 §4.5 already discards a pong naming a denylisted skill before any answer is selected, and this applies the same check to the full-answer responses that follow;" — PIPELINE-1 §4.5 now discards a denylisted pong at the poll stage; the old sentence explained a gap that no longer exists at that layer, so it is restated in terms of the current two-stage filtering.Ran
ste_lint.pyon every edited file against itsdevcounterpart: no new hit category introduced anywhere, and per-100-word ratios are unchanged (the smalltotaldeltas track only the words added by the fixes themselves).