Skip to content

docs: cross-link the technical manual - #505

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

docs: cross-link the technical manual#505
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

  • docs/index.md, ovos-skill.md, decorators.md, skill-classes.md: shrink duplicated content and link to the corresponding OVOS Technical Manual pages instead of restating them.
  • Fix stale entry-point group name opm.skills -> opm.skill in README.md and docs/index.md.
  • Fix docs/skill-classes.md and docs/index.md: remove the nonexistent CommonQuerySkill base class, document @common_query() on a plain OVOSSkill instead, and add the missing IdleDisplaySkill to the hierarchy.
  • Fix docs/skill-interaction.md: the documented default ask_yesno plugin name (ovos-solver-yes-no-plugin) does not match any registered opm.agents.yesno entry point; the shipped plugin is ovos-yes-no-plugin, and the lookup always falls back to HeuristicYesNoEngine.

The OVOS Technical Manual (https://tigregotico.github.io/ovos-technical-manual/) is the canonical, actively maintained doc set for skill authoring; these repo docs now point into it instead of drifting independently.

Test plan

  • Docs-only change, no code affected.
  • Spot-check rendered links resolve on the manual site.

🤖 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: 08a304cf-3eb0-468a-9757-c0b22cec75a3

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

The automated inspectors have returned with their findings. 🕵️‍♂️

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

🔍 Lint

Everything looks good so far! ✅

ruff: issues found — see job log

⚖️ License Check

Checking for any potential legal hurdles. 🚧

✅ No license violations found.

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

📋 Repo Health

A detailed health report for the project. 📝

✅ All required files present.

Latest Version: 9.3.2a2

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

🔒 Security (pip-audit)

Checking for any digital cooties in your dependencies... 👾

✅ No known vulnerabilities found (74 packages scanned).

🔨 Build Tests

Checking if the architectural integrity holds up. 🏛️

✅ All versions pass

Python Build Install Tests
3.10
3.11
3.12
3.13
3.14

Keeping the code clean, one PR at a time ✨

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