OpenVoiceOS / OpenVoiceOS/architecture

Adoption: move the OVOS specifications out of Draft status

Open
#5 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation help wanted question RfD
Dominant language
No language data
Stars
3
Forks
0
Avg merge
15h 20m
Merged PRs (30d)
90

Description

Adoption — move the OVOS specifications out of Draft

Tracking issue for the official adoption of the OVOS specifications — the point at which the family of specs stops being Draft and becomes a stable, adopted contract.

Today every spec header reads Status: Draft, and the README carries a notice that the documents may still change. Adoption flips that: each spec's Status field moves from Draft to a stable status, and the draft notice is removed.

This issue MUST NOT be closed until all of the following hold

  • Community feedback. The community has been given the opportunity to review and respond, and the feedback has been gathered and addressed (or explicitly dispositioned).
  • Core team consensus. Every member of the OVOS core team agrees the specifications are ready to be adopted.
  • Implementation conformance. Every existing OVOS repository that these specifications govern has been brought into compliance — see migration epic #7.

Only when all three are satisfied may a maintainer flip each spec's Status to a stable value, remove the draft notice from the README, and close this issue.

Specs in dev (merged, awaiting adoption)

  • OVOS-INTENT-1 — Sentence Template Grammar
  • OVOS-INTENT-2 — Locale Resource Formats
  • OVOS-INTENT-3 — Intent Definition
  • OVOS-MSG-1 — Bus Message Specification
  • OVOS-SESSION-1 — Session Carrier Wire Shape (PR #22)
  • OVOS-SESSION-2 — Session Lifecycle and State Ownership (PR #27, #36)
  • OVOS-PIPELINE-1 — Utterance Lifecycle and Pipeline (PR #11)
  • OVOS-INTENT-4 — Intent and Entity Registration Bus Contract (PR #9)
  • OVOS-CONTEXT-1 — Intent Context (PR #18)
  • OVOS-TRANSFORM-1 — Transformer Plugins (PR #20)
  • OVOS-STOP-1 — Stop Pipeline Plugin (PR #33)

Specs still under proposal (open PRs)

  • OVOS-INTENT-2 v3.prompt resource role (PR #4, issue #6)
  • OVOS-CONVERSE-1 — Active Handlers and Interactive Response (PR #25)
  • OVOS-PERSONA-1 — Persona Pipeline Plugin (PR #37)
  • OVOS-AUDIO-1 — Audio Output Service (PR #38)
  • OVOS-FALLBACK-1 — Fallback Pipeline Plugin (PR #39)
  • OVOS-COMMON-QUERY-1 — Common Query Pipeline Plugin (PR #40)
  • OVOS-BRIDGE-1 — Bus Bridge and Opaque Relay (PR #43)
  • OVOS-INTENT-4 §11 — Session-scoped Intent Registration (PR #45)
  • OVOS-AUDIO-IN-1 — Audio Input Service (PR #51)
  • OVOS-USER-ID-1 — User Identity Resolution (PR #54, issue #53)

Specs under proposal are not in the adoption set until merged; they leave Draft on their own timeline once per-spec adoption criteria are met.

After adoption

Adoption does not freeze the specifications. Changes continue through the normal process — a pull request that bumps the affected spec's Version and adds a CHANGELOG entry. Versioning follows semantic versioning in spirit: breaking changes are identified as such.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with this issue's adoption checklist, the specifications listed here, the README draft notice, and migration epic #7. Track community feedback, core-team consensus, and implementation conformance before changing each specification's status and removing the README notice. Done means all three prerequisites are satisfied and every adoption-set specification has a stable status.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.