docs(SUP-1313): rewrite README around modules + dependency attribution - #15
Merged
Conversation
Reframe the public README so a new reader can answer two questions quickly: what does jarvOS itself do, and what comes from the runtime or other dependencies. - Lead with the three jarvOS modules (@jarvos/secondbrain, @jarvos/memory, @jarvos/ontology) plus the portable core/templates and runtime adapters. - Add a layer-ownership table covering content, recall, worldview, behavior, execution, and runtime. - Split owned-vs-dependency responsibilities into explicit sections for jarvOS, OpenClaw, Hermes, Obsidian/QMD/lossless-claw, and Paperclip, mirroring runtimes/*/README.md. - Trim the duplicated OpenClaw quick-start so it points at the adapter README instead of inlining workspace seeding. - Promote PUBLIC_BASELINE.md and modules/README.md as the canonical follow-on reads. Smoke test still passes (27/27). Co-Authored-By: Paperclip <noreply@paperclip.ing>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughRewrote Documentation Restructuring
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related issues
Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Review rate limit: 0/1 reviews remaining, refill in 60 minutes.Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
108-114: ⚡ Quick winAlign the referenced Paperclip sync script path.
The README says the sync target is via
scripts/sync-to-paperclip(Line 112-113). In the repo context, the module appears to have ascripts/sync-to-paperclip.jsfile, so the README may be slightly misleading.Suggested patch
- - Sync target for `@jarvos/ontology` projects via `scripts/sync-to-paperclip` in that module + - Sync target for `@jarvos/ontology` projects via `scripts/sync-to-paperclip.js` in that module🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 108 - 114, The README currently references the sync script as `scripts/sync-to-paperclip`; update the documentation to reference the actual script filename `scripts/sync-to-paperclip.js` so the path matches the repository layout (edit the README section under "Provided by Paperclip" that mentions the sync target and replace `scripts/sync-to-paperclip` with `scripts/sync-to-paperclip.js`).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 13-29: The README contains an unclosed fenced code block that
begins with ``` in the "What’s in this repo" tree snippet; close the fence by
adding a matching ``` on its own line immediately after the tree block (i.e.,
before the paragraph starting "Everything jarvOS-owned...") so the rest of
README.md renders correctly.
---
Nitpick comments:
In `@README.md`:
- Around line 108-114: The README currently references the sync script as
`scripts/sync-to-paperclip`; update the documentation to reference the actual
script filename `scripts/sync-to-paperclip.js` so the path matches the
repository layout (edit the README section under "Provided by Paperclip" that
mentions the sync target and replace `scripts/sync-to-paperclip` with
`scripts/sync-to-paperclip.js`).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
This was referenced May 8, 2026
This was referenced May 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrites the public jarvOS README so a new reader can quickly answer two questions: what does jarvOS itself do, and what comes from the runtime or other dependencies.
@jarvos/secondbrain,@jarvos/memory,@jarvos/ontology) plus the portablecore//templates/and runtime adapters.runtimes/*/README.mdandmodules/README.md.runtimes/openclaw/README.mdfor the full adapter checklist.PUBLIC_BASELINE.mdandmodules/README.mdas the canonical follow-on reads.Paperclip issue: SUP-1313 — Rewrite jarvOS README around modules and dependency attribution.
GitHub issue: Closes #14.
Test plan
bash scripts/smoke-test.sh— 27/27 passedSummary by CodeRabbit