SUP-1694 Make v0.1 GBrain-first#40
Conversation
📝 WalkthroughWalkthroughThis PR updates documentation across the jarvOS repository to consistently reposition ChangesGBrain-first Resolver Narrative Alignment
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add 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. Comment |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 9552d3d65d
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| context-ready Markdown after checking GBrain first, expanding graph context, and | ||
| using QMD only as fallback/source support. It does not inject anything on its |
There was a problem hiding this comment.
For OpenClaw setups where GBrain is installed but QMD is missing or unhealthy, this documented default command will still invoke QMD and exit non-zero: recallBundle runs QMD whenever includeQmd is not disabled and computes ok as gbrainCommand.ok && (!includeQmd || engines.qmd.ok) && ... in modules/jarvos-gbrain/src/index.js lines 948-971. Calling QMD “only as fallback/source support” makes the default integration sound non-blocking, but runtime adapters following this text need to pass --no-qmd or the recall command can fail despite successful GBrain results.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Fixed in 809e203. The OpenClaw docs now state that QMD is enabled by default and that missing/unhealthy QMD makes the bundle unhealthy even when GBrain succeeds; GBrain-only runtime calls are documented with --no-qmd. The release readiness check now requires --no-qmd to stay documented.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/architecture/jarvos-architecture.md (1)
79-81: 💤 Low valueMinor style observation: three consecutive list items starting with the same pattern.
LanguageTool flagged that three consecutive bullet points start with "
@jarvos/" or a similar package/component pattern. While the content is clear and accurate, you might consider varying the sentence structure for improved readability.🤖 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 `@docs/architecture/jarvos-architecture.md` around lines 79 - 81, The three consecutive bullets start similarly and hurt readability; rephrase the list items to vary sentence openings while preserving meaning — e.g., keep the first as "`@jarvos/gbrain` owns the GBrain-first structured resolver and curated pages for GBrain" but change the second to start with "QMD functions as a fast broad vault-search and exact source-note dependency, not the graph layer" and the third to "OpenClaw's `memory-wiki` acts as a native runtime diagnostic/compiled-wiki layer rather than the primary GBrain import source," referencing `@jarvos/gbrain`, QMD, and OpenClaw `memory-wiki` so reviewers can locate and update the three bullets.
🤖 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.
Inline comments:
In `@scripts/release-readiness-check.js`:
- Around line 156-159: The current gbrainCorpus construction uses readText
inside .map and will throw if a file exists but is unreadable; wrap the readText
call for each file (referencing gbrainNarrativeFiles, exists, readText, and
gbrainCorpus) in a try/catch so a read error does not crash the script — on
error capture the filename and error and add a structured readiness failure (or
a placeholder message) to the readiness results, and continue processing the
remaining files; ensure gbrainCorpus still joins only successfully read file
contents while failures are recorded for reporting.
---
Nitpick comments:
In `@docs/architecture/jarvos-architecture.md`:
- Around line 79-81: The three consecutive bullets start similarly and hurt
readability; rephrase the list items to vary sentence openings while preserving
meaning — e.g., keep the first as "`@jarvos/gbrain` owns the GBrain-first
structured resolver and curated pages for GBrain" but change the second to start
with "QMD functions as a fast broad vault-search and exact source-note
dependency, not the graph layer" and the third to "OpenClaw's `memory-wiki` acts
as a native runtime diagnostic/compiled-wiki layer rather than the primary
GBrain import source," referencing `@jarvos/gbrain`, QMD, and OpenClaw
`memory-wiki` so reviewers can locate and update the three bullets.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 4f7621d8-a2e7-490f-a5c3-d79c61b44c37
📒 Files selected for processing (9)
CHANGELOG.mdREADME.mddocs/architecture/jarvos-architecture.mddocs/releases/v0.1.0.mdmodules/README.mdmodules/jarvos-gbrain/README.mdmodules/jarvos-gbrain/package.jsonruntimes/openclaw/README.mdscripts/release-readiness-check.js
| const gbrainCorpus = gbrainNarrativeFiles | ||
| .filter((file) => exists(file)) | ||
| .map((file) => `${file}\n${readText(file)}`) | ||
| .join('\n\n'); |
There was a problem hiding this comment.
Handle unreadable narrative files without crashing the check.
Line 156–159 can throw if a file exists but cannot be read, which aborts the whole script instead of returning a structured readiness failure.
Suggested fix
- const gbrainCorpus = gbrainNarrativeFiles
- .filter((file) => exists(file))
- .map((file) => `${file}\n${readText(file)}`)
- .join('\n\n');
+ let gbrainCorpus = '';
+ try {
+ gbrainCorpus = gbrainNarrativeFiles
+ .filter((file) => exists(file))
+ .map((file) => `${file}\n${readText(file)}`)
+ .join('\n\n');
+ } catch (error) {
+ fail('GBrain-first release narrative files', `Unreadable file: ${error.message}`);
+ }🤖 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 `@scripts/release-readiness-check.js` around lines 156 - 159, The current
gbrainCorpus construction uses readText inside .map and will throw if a file
exists but is unreadable; wrap the readText call for each file (referencing
gbrainNarrativeFiles, exists, readText, and gbrainCorpus) in a try/catch so a
read error does not crash the script — on error capture the filename and error
and add a structured readiness failure (or a placeholder message) to the
readiness results, and continue processing the remaining files; ensure
gbrainCorpus still joins only successfully read file contents while failures are
recorded for reporting.
|
Closing as superseded before the v0.1 final audit. The release-required jarvOS repo work landed in #39 at 97f2177 (docs(SUP-1694): make v0.1 GBrain-first release-ready), and the separate README positioning lane is tracked in levineam/clawd#353.\n\nThis branch is now diverged/CONFLICTING against main and should not be used for the v0.1.0 release. No changelog date, tag, or GitHub Release is being created from this disposition task. |
1 participant
Summary
Verification
Paperclip: SUP-1694
Summary by CodeRabbit
Documentation
Chores