Skip to content

docs: cross-link the technical manual - #206

Draft
JarbasAl wants to merge 1 commit into
devfrom
docs/manual-crosslinks
Draft

docs: cross-link the technical manual#206
JarbasAl wants to merge 1 commit into
devfrom
docs/manual-crosslinks

Conversation

@JarbasAl

@JarbasAl JarbasAl commented Aug 1, 2026

Copy link
Copy Markdown
Member

Summary

  • Fix README.md persona examples to use the canonical handlers key instead of the legacy solvers alias.
  • Fix docs/hivemind.md default persona example to use handlers.
  • Trim README.md's Persona Intents and Pipeline Configuration sections to a short summary that links to the OVOS technical manual instead of duplicating its content.

🤖 Generated with Claude Code

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Aug 1, 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 Plus

Run ID: 66c0d04f-d096-476b-822e-f94d5f37f19d

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

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 Aug 1, 2026

Copy link
Copy Markdown
Contributor

At your service! I've gathered all the check results for you. 🫡

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

🌍 Locale Build

The latest check report is officially filed. 📁

✅ Locale properly configured (342 files, 20 languages)

Locale directories found:

  • ovos_persona/locale

Localization coverage:

  • ovos_persona/locale: 342 files in 20 languages (ca, pt, en-us, ca-ES, gl...)

pyproject.toml:[tool.setuptools.package-data.ovos_persona] includes locale

  • locale/**/*.voc
  • locale/**/*.intent
  • locale/**/*.dialog
  • locale/**/*.entity
  • locale/**/*.rx
  • locale/**/*.word
  • locale/**/*

Build manifest: ✅ 345 locale files included in package

🏷️ Release Preview

Ensuring the release process is fully automated. 🤖

Current: 0.9.0a16Next: 0.9.0a17

Signal Value
Label (none)
PR title docs: cross-link the technical manual
Bump alpha

✅ PR title follows conventional commit format.


🚀 Release Channel Compatibility

Predicted next version: 0.9.0a17

Channel Status Note Current Constraint
Stable Too new (must be <0.7.0) ovos-persona>=0.6.23,<0.7.0
Testing Compatible ovos-persona>=0.6.24,<1.0.0
Alpha Compatible ovos-persona>=0.9.0a16

⚖️ License Check

Verifying that everything is above board legally. ⚓

✅ No license violations found.

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

🔍 Lint

The latest check cycle has concluded. 🔄

ruff: issues found — see job log

🔒 Security (pip-audit)

Security report: No threats detected in the area. ✅

✅ No known vulnerabilities found (80 packages scanned).

🔌 Plugin Detection

Ensuring the plugin's 'API' version is compatible. 🌐

Plugin Status: ERRORS (1)

Plugin Info:

  • Name: ovos-persona
  • Description: persona pipeline for ovos

Plugin Types: pipeline, agents.memory

OPM Detection:

Plugin Type Wheel Editable
agents.memory
pipeline

Entry Point Validation:

Entry Point Type Import Interface
ovos-agents-short-term-memory-plugin agents.memory
ovos-persona-pipeline-plugin pipeline ✅ 1824ms

⊘ No settingsmeta.json
requires-python >=3.10 — running Python 3.11

Issues:

  • ❌ Import time for ovos-persona-pipeline-plugin exceeds 500ms (1824ms)
  • ⚠️ No settingsmeta.json found
  • ⚠️ No settingsmeta.json found

📊 Coverage

Ensuring we've got all the bases covered! ⚾

⚠️ 73.0% total coverage

Per-file coverage (4 files)
File Coverage Missing lines
ovos_persona/version.py 0.0% 5
ovos_persona/solvers.py 69.6% 35
ovos_persona/__init__.py 73.1% 108
ovos_persona/memory.py 96.7% 1

Full report: download the coverage-report artifact.

📋 Repo Health

Ensuring the repo is ready for a marathon (aka long-term support). 🏁

✅ All required files present.

Latest Version: 0.9.0a16

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

🔨 Build Tests

Running the final assembly check. 🔧

✅ All versions pass

Python Build Install Tests
3.10
3.11
3.12
3.13
3.14

Your loyal automated servant. 💂‍♀️

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