Skip to content

docs: cross-link the technical manual - #73

Merged
JarbasAl merged 1 commit into
devfrom
docs/manual-crosslinks
Aug 31, 2026
Merged

docs: cross-link the technical manual#73
JarbasAl merged 1 commit into
devfrom
docs/manual-crosslinks

Conversation

@JarbasAl

@JarbasAl JarbasAl commented Aug 1, 2026

Copy link
Copy Markdown
Member

🤖 Auto-generated by Claude Fable 5 (claude-fable-5) via Claude Code — NOT human-reviewed. Verify before acting.

Summary

  • docs/index.md: fix the configuration table, which stated the wrong default bind address (0.0.0.0 instead of the shipped 127.0.0.1) and self-contradicted docs/configuration.md. Trimmed the duplicated table down to a short summary with a link to configuration.md and the manual's Bus Service page.
  • README.md: fix the same wrong 0.0.0.0 example default and trim the config JSON snippet, which duplicated docs/configuration.md, to a short pointer.

The OVOS Technical Manual (https://tigregotico.github.io/ovos-technical-manual/) is the canonical, actively maintained doc set; 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

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f613bf6e-d411-4050-b0b6-58426bc7a0ec


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

The results of your automated verification are here! 📜

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

🔒 Security (pip-audit)

I've performed a digital frisk of this contribution. 👮‍♂️

✅ No known vulnerabilities found (55 packages scanned).

🔍 Lint

Ensuring the quality bar remains high. 📈

ruff: issues found — see job log

⚖️ License Check

Ensuring our project is well-protected legally. 🛡️

✅ No license violations found.

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

📊 Coverage

Checking the integrity of our test cases. 💎

⚠️ 78.2% total coverage

Per-file coverage (8 files)
File Coverage Missing lines
ovos_messagebus/version.py 0.0% 5
ovos_messagebus/ssl_utils.py 25.9% 20
ovos_messagebus/__main__.py 75.4% 14
ovos_messagebus/event_handler.py 81.7% 11
ovos_messagebus/backends/webrockets_backend.py 96.0% 3
ovos_messagebus/__init__.py 100.0% 0
ovos_messagebus/backends/__init__.py 100.0% 0
ovos_messagebus/load_config.py 100.0% 0

Full report: download the coverage-report artifact.

🔨 Build Tests

Checking if all the bolts are tightened. 🔩

✅ All versions pass

Python Build Install Tests
3.10
3.11
3.12
3.13

Automating the path to a better future 🌈

@JarbasAl
JarbasAl marked this pull request as ready for review August 31, 2026 14:24
@JarbasAl
JarbasAl merged commit 7ad04d4 into dev Aug 31, 2026
11 of 12 checks passed
@JarbasAl
JarbasAl deleted the docs/manual-crosslinks branch August 31, 2026 14:24
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