Skip to content

docs: drop the ovos- filename prefix; refresh the spec index#55

Merged
JarbasAl merged 2 commits into
devfrom
chore/standardize-filenames
Jun 23, 2026
Merged

docs: drop the ovos- filename prefix; refresh the spec index#55
JarbasAl merged 2 commits into
devfrom
chore/standardize-filenames

Conversation

@JarbasAl

@JarbasAl JarbasAl commented May 28, 2026

Copy link
Copy Markdown
Member

Summary

Standardizes all spec filenames to <name>.md / <name>-<version>.md by dropping the redundant ovos- prefix. The repo is already the OVOS architecture repo — the prefix adds noise without value.

Renames

Before After
ovos-intent-1.md intent-1.md
ovos-intent-2.md intent-2.md
ovos-intent-3.md intent-3.md
ovos-intent-4.md intent-4.md
ovos-msg-1.md msg-1.md
ovos-pipeline-1.md pipeline-1.md
ovos-session-1.md session-1.md
ovos-session-2.md session-2.md
ovos-stop-1.md stop-1.md
ovos-audio-in-1.md audio-in.md

Companion changes on open PR branches

  • spec/bridge: ovos-bridge-1.mdbridge-1.md
  • spec/user-id: spec/user-id/ovos-user-id-1.mduser-id-1.md (moved to root)
  • spec/audio: audio-out.md (already clean)
  • spec/audio-input: audio-in.md (already clean — consistent with this PR)
  • All other open PR branches: fallback.md, converse.md, persona.md, transformer.md, common-query.md (already clean)

Notes

  • README, APPENDIX, GLOSSARY, CHANGELOG, and all appendix/ file links updated
  • Spec ID headers (OVOS-MSG-1, OVOS-PIPELINE-1, etc.) are unchanged — only filenames change
  • Open PRs will need rebase after this merges

Summary by CodeRabbit

  • Documentation
    • Updated specification references in the Glossary and README documentation to align with revised file organization for better clarity and consistency across documentation resources.

Review Change Stack

Standardize to <name>.md / <name>-<version>.md:
  ovos-intent-{1,2,3,4}.md  → intent-{1,2,3,4}.md
  ovos-msg-1.md              → msg-1.md
  ovos-pipeline-1.md         → pipeline-1.md
  ovos-session-{1,2}.md      → session-{1,2}.md
  ovos-stop-1.md             → stop-1.md
  ovos-audio-in-1.md         → audio-in.md

README, APPENDIX, GLOSSARY, CHANGELOG, and appendix/ links updated.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented May 28, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

This PR standardizes spec file references across repository documentation. Glossary and README index tables are updated to use new spec document filenames, removing the ovos- prefix from Intent/Bus/Orchestrator spec links and ensuring consistent citation targets throughout.

Changes

Spec File Reference Updates

Layer / File(s) Summary
Spec file reference updates across documentation
GLOSSARY.md, README.md
Glossary glossary table entries and README spec index tables are updated to reference intent, bus, and orchestrator spec documents by their new standardized filenames (removing ovos- prefix and updating paths like intent-*.md, msg-1.md, pipeline-1.md, stop-1.md, audio-in.md).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • OpenVoiceOS/architecture#14: Both PRs update spec-linking targets across documentation; this PR standardizes spec filename references (removing ovos- prefix) while the related PR expands INTENT and PIPELINE documentation context.

Poem

🐰 Hops through the glossary with glee,
Links now point where they ought to be,
ovos- be gone, the specs are free,
Intent and message align in harmony! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title 'docs: drop the ovos- filename prefix; refresh the spec index' directly and accurately summarizes the main changes: removing the 'ovos-' prefix from spec filenames and updating documentation index tables.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/standardize-filenames

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 and usage tips.

@coderabbitai

coderabbitai Bot commented May 28, 2026

Copy link
Copy Markdown

Actionable comments posted: 0

@JarbasAl

Copy link
Copy Markdown
Member Author

Merge-ready. No dangling ovos- filename references remain in the renamed files (README, APPENDIX, GLOSSARY, CHANGELOG, and appendix/ are all updated).

After this merges, the following open PRs will need a filename-reference refresh (their GLOSSARY.md still links to ovos-intent-*.md, ovos-msg-1.md, etc.):

The new spec files introduced by those PRs (audio-out.md, persona.md, transformer.md, intent-context.md, user-id-1.md) already use the clean naming convention — no renames needed for them, only GLOSSARY.md cross-link updates.

…ioning policy

- Rename the ten on-dev spec files from ovos-<name>.md to <name>.md; the
  OVOS-<ID> spec identifiers are unchanged. README and GLOSSARY links updated.
- README — rebuild the spec index: the Version column now carries the V0/V1/V2
  compatibility class, list every spec with its unprefixed link, and group the
  I/O surfaces (audio-in, audio-out, gui) into their own stack.
- Stamp the compatibility class into the headers of the on-dev specs that have
  no other open PR: MSG-1 = 1, STOP-1 = 2, AUDIO-IN-1 = 2.
- README Contributing and the CHANGELOG preamble: the Version field is the
  compatibility class, not a per-revision counter; a normative PR adds a
  CHANGELOG entry and sets the class.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@JarbasAl JarbasAl changed the title chore: drop ovos- prefix from all spec filenames docs: drop the ovos- filename prefix; refresh the spec index Jun 22, 2026
@JarbasAl JarbasAl merged commit 54c6a0e into dev Jun 23, 2026
1 check passed
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