Skip to content

docs: surface OVOS Architecture repo + claim OVOS-MSG-1 conformance#220

Draft
JarbasAl wants to merge 2 commits into
devfrom
docs/architecture-conformance
Draft

docs: surface OVOS Architecture repo + claim OVOS-MSG-1 conformance#220
JarbasAl wants to merge 2 commits into
devfrom
docs/architecture-conformance

Conversation

@JarbasAl

Copy link
Copy Markdown
Member

Follow-up to #218. Now that the architecture repo is published and ovos_bus_client.Message re-exports the spec-tools reference implementation of OVOS-MSG-1, this package can claim conformance — and should make the spec discoverable.

Changes

  • README.md
    • Top-level conformance callout below the tagline: links to OVOS-MSG-1 and the OVOS Architecture repo, names ovos-spec-tools as the reference implementation.
    • Related section now lists OVOS Architecture and ovos-spec-tools alongside ovos-pydantic-models and HiveMind.
  • docs/concepts.md — opening note pointing at OVOS-MSG-1 as the normative source for the envelope, routing keys, session carrier and derivations described on the page.
  • docs/session.md — links the two normative session fields (session_id, lang) to OVOS-MSG-1 §4 and frames the rest of the Session class (pipeline, site_id, IntentContextManager, persona, preferences) as layer-2 extensions per the spec.

No code changes. 553 tests still pass.

🤖 Generated with Claude Code

@coderabbitai

coderabbitai Bot commented May 24, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: faa37a3d-719d-4cf6-a19e-8fc16f76cf34

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/architecture-conformance

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.

@github-actions

github-actions Bot commented May 24, 2026

Copy link
Copy Markdown
Contributor

Automated check summary ready. 📊

I've aggregated the results of the automated checks for this PR below.

📋 Repo Health

Scanning for any signs of 'copy-paste' obesity. 🍕

✅ All required files present.

Latest Version: 2.6.5a1

ovos_bus_client/version.py — Version file
README.md — README
LICENSE — License file
pyproject.toml — pyproject.toml
⚠️ setup.py — setup.py
CHANGELOG.md — Changelog
ovos_bus_client/version.py has valid version block markers

🔒 Security (pip-audit)

Security check! Are we safe from vulnerabilities? 🛡️

✅ No known vulnerabilities found (52 packages scanned).

📊 Coverage

I've been crunching the numbers! Here's how the test coverage changed. 📈

91.0% total coverage (threshold: 65.0%)

Files below 80% coverage (1 file)
File Coverage Missing lines
ovos_bus_client/message.py 77.1% 25

Full report: download the coverage-report artifact.

⚖️ License Check

Navigating the maze of open-source compliance. 🧩

✅ No license violations found.

Policy: Apache 2.0 (universal donor). StrongCopyleft / NetworkCopyleft / WeakCopyleft / Other / Error categories fail. MPL allowed.

🏷️ Release Preview

I've checked the 'Bug Fixes' list for accuracy. 🐛

Current: 2.6.5a1Next: 2.6.5a2

Signal Value
Label (none)
PR title docs: surface OVOS Architecture repo + claim OVOS-MSG-1 conformance
Bump alpha

✅ PR title follows conventional commit format.


🚀 Release Channel Compatibility

Predicted next version: 2.6.5a2

Channel Status Note Current Constraint
Stable Too new (must be <1.4.0) ovos-bus-client>=1.3.4,<1.4.0
Testing Too new (must be <2.0.0) ovos-bus-client>=1.3.7,<2.0.0
Alpha Compatible ovos-bus-client>=2.6.5a1

🔍 Lint

Everything looks good so far! ✅

ruff: issues found — see job log

🔨 Build Tests

I've inspected the foundation of your PR. 🕵️‍♂️

✅ All versions pass

Python Build Install Tests
3.10
3.11
3.12
3.13
3.14

Standard Automated Signature v2.0 🏷️

@JarbasAl
JarbasAl marked this pull request as draft May 24, 2026 20:13
JarbasAl added a commit that referenced this pull request May 24, 2026
PR #220 waits on the architecture-side specs that formalise the
session carrier and the intent-context sub-object. Forward-link to
those drafts from concepts.md and session.md so readers know where
the layer-2 shape is being normatively pinned.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
JarbasAl and others added 2 commits July 15, 2026 05:53
- README: top-level conformance callout citing OVOS-MSG-1 and the
  architecture repo; Related section lists architecture and
  ovos-spec-tools alongside ovos-pydantic-models.
- docs/concepts.md: opening note pointing at OVOS-MSG-1 as the
  normative source for the envelope, routing keys, session carrier
  and derivations.
- docs/session.md: link the two normative session fields
  (session_id, lang) to OVOS-MSG-1 §4 and frame the rest as layer-2
  extensions per the spec.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
PR #220 waits on the architecture-side specs that formalise the
session carrier and the intent-context sub-object. Forward-link to
those drafts from concepts.md and session.md so readers know where
the layer-2 shape is being normatively pinned.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@JarbasAl
JarbasAl force-pushed the docs/architecture-conformance branch from 3fa5f3c to bc3fe74 Compare July 15, 2026 04:54
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