Skip to content

docs(SUP-1768): align jarvOS category framing - #45

Merged
levineam merged 1 commit into
mainfrom
SUP-1768/jarvos-category-framing
May 17, 2026
Merged

docs(SUP-1768): align jarvOS category framing#45
levineam merged 1 commit into
mainfrom
SUP-1768/jarvos-category-framing

Conversation

@levineam

@levineam levineam commented May 17, 2026

Copy link
Copy Markdown
Owner

Thinking Path

  1. SUP-1768 follows SUP-1765's guardrail that jarvOS is the portable operating layer, while OpenClaw is one adapter.
  2. The public metadata still described jarvOS as running on top of OpenClaw, which narrowed the category incorrectly.
  3. The README already mostly had the right shape, so the fix should tighten language rather than rewrite the product story.
  4. The architecture docs needed the durable boundary: runtimes own orchestration, jarvOS owns portable context and governance.
  5. The package and skill bundle descriptions should avoid treating OpenClaw as the default product boundary.
  6. A short canonical boundary doc gives future contributors a reusable pattern instead of another one-off wording patch.
  7. Verification should combine the repo smoke suite, markdown lint, and an explicit audit for the old drift phrases.

What Changed

  • Updated package metadata and bootstrap copy so jarvOS is framed as a portable personal-AI operating layer for compatible runtimes.
  • Tightened README and release-note language around runtime adapters and added an explicit "jarvOS is not the runtime" boundary.
  • Reworked the canonical architecture layer section from "OpenClaw vs jarvOS" to "Runtimes vs jarvOS".
  • Added docs/architecture/product-category-and-boundaries.md with category, architecture boundary, and guardrails.
  • Updated the public skills module wording from "OpenClaw-style agents" to compatible agent runtimes.

Verification

  • npm test passed.
  • markdownlint '**/*.md' --ignore 'node_modules/**' --ignore '.github/**' --config .markdownlint.json passed.
  • rg -n "on top of OpenClaw|on top of your OpenClaw|personalization layer|OpenClaw configuration|OpenClaw-style|built on top of OpenClaw" -g '!runtimes/openclaw/**' returned no matches.
  • npm run release:check:candidate reached smoke-test pass but reported the pre-existing release-tag condition: v0.1.0 already exists.

Risks

  • Low risk: docs and package metadata only.
  • Bootstrap smoke output changed by one sentence, but the installer flow and generated files are unchanged.
  • Some older OpenClaw-specific module docs remain because they describe real runtime adapter or diagnostic boundaries, not the public product category.

Model Used

OpenAI GPT-5 Codex, coding agent with repository editing, shell verification, and GitHub PR creation capabilities.

Checklist

  • Changes are scoped to SUP-1768.
  • Public jarvOS framing treats OpenClaw as a runtime adapter, not the product boundary.
  • Tests and markdown lint pass locally.
  • PR file list was checked against origin/main..HEAD and contains only intended files.
  • No secrets, private notes, or machine-local config were added.

Summary by CodeRabbit

  • Documentation
    • Repositioned jarvOS as a portable personal-AI operating layer compatible with multiple agent runtimes
    • Added new architecture documentation defining product boundaries and runtime adapter responsibilities
    • Updated descriptions throughout to emphasize multi-runtime compatibility

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 17, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

This PR refactors jarvOS messaging across documentation, release notes, CLI help, and package metadata to position the project as a portable personal AI operating layer for compatible agent runtimes, replacing prior OpenClaw-specific language with runtime-agnostic framing and explicit runtime-adapter boundaries.

Changes

jarvOS Portable Runtime-Agnostic Messaging

Layer / File(s) Summary
Product category and architecture decision updates
docs/architecture/product-category-and-boundaries.md, docs/architecture/jarvos-architecture.md
New product-category doc establishes jarvOS as a local-first operating layer with layered components (secondbrain, memory, ontology, knowledge, skills, tracker, adapters) and guardrails. Architecture doc refines layer-model framing to distinguish jarvOS as the operating layer atop compatible runtimes, adds runtime-adapter responsibility, and expands instance-packaging guidance.
README and release-notes messaging
README.md, docs/releases/v0.1.0.md
README adapts the runtime-adapters bullet and expands the Runtime Adapters section to explain jarvOS as a user-owned context/governance layer hydrated by runtimes, with a link to the new product-category doc. Release notes reframe v0.1.0 as enabling hydration of multiple compatible runtimes (OpenClaw, Hermes, Codex, Claude).
CLI help and bootstrap startup messaging
bootstrap.js
Usage description and startup console message updated to guide setup of a portable jarvOS workspace instead of setup "on top of OpenClaw," with no functional logic changes.
Package descriptions and module documentation
package.json, modules/README.md, modules/jarvos-skills/README.md, modules/jarvos-skills/package.json
Main and skills package descriptions, and module READMEs, update language to reference compatible agent runtimes instead of OpenClaw-specific terminology, aligning package metadata across the project.

Estimated Code Review Effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly Related PRs

  • levineam/jarvOS#43: Both PRs update README.md to reposition jarvOS around layered architecture and reword runtime-adapters narrative across compatible agent runtimes.
  • levineam/jarvOS#15: Both PRs modify README.md to reframe jarvOS's layered architecture, ownership boundaries, and explicit runtime-adapter discussion.
  • levineam/jarvOS#36: Both PRs touch docs/releases/v0.1.0.md; this PR adjusts the v0.1.0 framing while the retrieved PR introduces the v0.1.0 release process.

Suggested Labels

jarvis-managed

Poem

🐰 A rabbit hops through docs with care,
Reframing jarvOS here and there—
No more just OpenClaw's throne,
Now runtimes compatible own
A portable layer, all their own! 🌱✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs(SUP-1768): align jarvOS category framing' directly describes the main change: updating documentation and messaging to reframe jarvOS as a portable personal-AI operating layer for compatible runtimes rather than dependent on OpenClaw.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
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.

✏️ 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 SUP-1768/jarvos-category-framing

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
bootstrap.js (1)

171-171: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Inconsistent framing: "OpenClaw workspace path" contradicts runtime-agnostic messaging.

The interactive prompt still uses "OpenClaw workspace path" while the rest of the bootstrap messaging (lines 6, 418) has been updated to runtime-agnostic language. This contradicts the PR objective and may confuse users selecting non-OpenClaw runtimes.

📝 Suggested fix
-    ['WORKSPACE_PATH', `OpenClaw workspace path [${defaults.WORKSPACE_PATH}]: `],
+    ['WORKSPACE_PATH', `Workspace path [${defaults.WORKSPACE_PATH}]: `],
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@bootstrap.js` at line 171, The prompt string in the prompts array still reads
"OpenClaw workspace path" which contradicts the runtime-agnostic messaging
elsewhere; update the array entry that contains the literal "OpenClaw workspace
path [${defaults.WORKSPACE_PATH}]: " (referenced alongside
defaults.WORKSPACE_PATH) to a runtime-neutral label such as "workspace path"
(matching wording used in other prompts/messages) so the prompt no longer
mentions OpenClaw explicitly.
🧹 Nitpick comments (2)
package.json (1)

4-5: 💤 Low value

Consider updating keywords to align with runtime-agnostic messaging.

The description now references "compatible agent runtimes" (plural, runtime-agnostic), but the keywords array still singles out "openclaw". While OpenClaw is indeed one compatible runtime, including only it in keywords may undermine the portable, runtime-agnostic positioning. Consider either removing "openclaw" or adding other runtime names like "hermes", "codex", or using a generic keyword like "agent-runtime".

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@package.json` around lines 4 - 5, The keywords array in package.json
currently includes "openclaw", which conflicts with the runtime-agnostic wording
in the description; update the "keywords" array (the JSON property "keywords")
to reflect runtime-agnostic messaging by either removing "openclaw" or
replacing/expanding it with generic terms like "agent-runtime" and/or additional
runtimes such as "hermes" and "codex" so the package metadata aligns with the
plural "compatible agent runtimes".
modules/jarvos-skills/README.md (1)

22-37: ⚡ Quick win

Generalize installation examples to match runtime-agnostic messaging.

The introduction now describes "compatible agent runtimes" (plural, runtime-agnostic), but all installation examples still use OpenClaw-specific paths (/path/to/openclaw-workspace/skills). Consider using a generic placeholder like /path/to/runtime-workspace/skills or /path/to/agent-runtime/skills, or showing examples for multiple runtimes.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@modules/jarvos-skills/README.md` around lines 22 - 37, The README examples
use an OpenClaw-specific placeholder; update the installation examples that call
scripts/install-skills.js to use a runtime-agnostic placeholder (e.g.,
/path/to/agent-runtime/skills or /path/to/runtime-workspace/skills) or provide
two brief variants for different runtimes, and ensure the --dest examples and
the subset install example reference that generic path; locate the lines
invoking "node scripts/install-skills.js --dest ..." and replace the
"/path/to/openclaw-workspace/skills" occurrences with the chosen neutral
placeholder(s).
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@bootstrap.js`:
- Line 171: The prompt string in the prompts array still reads "OpenClaw
workspace path" which contradicts the runtime-agnostic messaging elsewhere;
update the array entry that contains the literal "OpenClaw workspace path
[${defaults.WORKSPACE_PATH}]: " (referenced alongside defaults.WORKSPACE_PATH)
to a runtime-neutral label such as "workspace path" (matching wording used in
other prompts/messages) so the prompt no longer mentions OpenClaw explicitly.

---

Nitpick comments:
In `@modules/jarvos-skills/README.md`:
- Around line 22-37: The README examples use an OpenClaw-specific placeholder;
update the installation examples that call scripts/install-skills.js to use a
runtime-agnostic placeholder (e.g., /path/to/agent-runtime/skills or
/path/to/runtime-workspace/skills) or provide two brief variants for different
runtimes, and ensure the --dest examples and the subset install example
reference that generic path; locate the lines invoking "node
scripts/install-skills.js --dest ..." and replace the
"/path/to/openclaw-workspace/skills" occurrences with the chosen neutral
placeholder(s).

In `@package.json`:
- Around line 4-5: The keywords array in package.json currently includes
"openclaw", which conflicts with the runtime-agnostic wording in the
description; update the "keywords" array (the JSON property "keywords") to
reflect runtime-agnostic messaging by either removing "openclaw" or
replacing/expanding it with generic terms like "agent-runtime" and/or additional
runtimes such as "hermes" and "codex" so the package metadata aligns with the
plural "compatible agent runtimes".

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 95c1ea43-5793-42e4-803e-5cf14b7f3bb5

📥 Commits

Reviewing files that changed from the base of the PR and between 4e46ff7 and e87ea6b.

📒 Files selected for processing (9)
  • README.md
  • bootstrap.js
  • docs/architecture/jarvos-architecture.md
  • docs/architecture/product-category-and-boundaries.md
  • docs/releases/v0.1.0.md
  • modules/README.md
  • modules/jarvos-skills/README.md
  • modules/jarvos-skills/package.json
  • package.json

@levineam
levineam merged commit 214fb6d into main May 17, 2026
6 checks passed
@levineam
levineam deleted the SUP-1768/jarvos-category-framing branch May 17, 2026 15:08
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