docs: clarify managed backend defaults#2426
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
✅ Files skipped from review due to trivial changes (3)
📝 WalkthroughWalkthroughUpdates to marketing, onboarding i18n, backend copy, and docs to state which components run locally (memory, vault, workspace state, runtime) and which default to managed services (sign‑in, model routing, web search proxying, Composio/OAuth). ChangesLocal vs. Managed Service Transparency
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (4)
gitbooks/overview/getting-started.md (1)
38-40: 💤 Low valueConsider breaking the long final sentence for readability.
The warning hint is excellent transparency messaging, but the last sentence is complex. Consider splitting it:
"Use the custom setup paths if you want to bring your own model, search, or Composio credentials. Note that some hosted features and real-time integration triggers still require the managed backend."
This preserves all the information while making it easier to parse.
🤖 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 `@gitbooks/overview/getting-started.md` around lines 38 - 40, The final sentence inside the warning hint is long and hard to parse; split it into two sentences as suggested so it's clearer: in the {% hint style="warning" %} block update the long sentence that begins "Use the custom setup paths if you want to bring your own model, search, or Composio credentials; some hosted features and real-time integration triggers still require the managed backend." into two sentences (e.g., "Use the custom setup paths if you want to bring your own model, search, or Composio credentials. Note that some hosted features and real-time integration triggers still require the managed backend.") so the content is easier to read while preserving the same meaning.app/src/lib/i18n/chunks/en-1.ts (1)
255-260: 💤 Low valueOptional: Strengthen line 259 by removing passive voice.
Current: "Can keep supported workloads on your machine"
Suggested: "Keep supported workloads on your machine"The modal "Can" weakens the benefit statement. Since this is describing what the custom mode enables, the active voice is clearer and more direct.
🤖 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 `@app/src/lib/i18n/chunks/en-1.ts` around lines 255 - 260, Update the localization entry for onboarding.runtimeChoice.custom.f3 to use active voice by replacing "Can keep supported workloads on your machine" with "Keep supported workloads on your machine"; locate the string in en-1.ts under the onboarding.runtimeChoice.custom keys and change the value for onboarding.runtimeChoice.custom.f3 accordingly so the modal copy is more direct.README.md (2)
71-71: 💤 Low valueConsider simplifying this sentence for readability.
The sentence is technically accurate but quite long. Consider breaking it into two sentences for easier scanning:
"Managed integrations use OpenHuman's Composio connector layer. OAuth handshakes and integration tool calls are proxied through the managed backend by default."
🤖 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 `@README.md` at line 71, The sentence starting "Managed integrations are backend-proxied through OpenHuman's Composio connector layer, so OAuth handshakes and integration tool calls use the managed backend path by default..." is too long and should be split for readability; replace it with two sentences such as "Managed integrations use OpenHuman's Composio connector layer. OAuth handshakes and integration tool calls are proxied through the managed backend by default." and then leave the following clause about configuring direct mode with your own Composio API key and hosting webhooks unchanged.
75-75: 💤 Low valueOptional: Clarify "under one subscription" phrasing.
The phrase "choose and proxy the right LLM (reasoning, fast, or vision) under one subscription" mixes technical routing details with billing/subscription messaging. Consider separating these concerns:
"By default, model routing uses the OpenHuman backend to select and proxy the right LLM for each workload (reasoning, fast, or vision). One subscription includes all models."
This makes the technical function and the billing benefit distinct.
🤖 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 `@README.md` at line 75, Split the combined technical-and-billing sentence about model routing into two clear sentences: update the README's "model routing" sentence to state that the OpenHuman backend selects and proxies the appropriate LLM for each workload (reasoning, fast, or vision), and add a separate sentence clarifying that one subscription includes access to all models; edit the existing paragraph where the phrase "choose and proxy the right LLM (reasoning, fast, or vision) under one subscription" appears to implement this separation.
🤖 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.
Nitpick comments:
In `@app/src/lib/i18n/chunks/en-1.ts`:
- Around line 255-260: Update the localization entry for
onboarding.runtimeChoice.custom.f3 to use active voice by replacing "Can keep
supported workloads on your machine" with "Keep supported workloads on your
machine"; locate the string in en-1.ts under the onboarding.runtimeChoice.custom
keys and change the value for onboarding.runtimeChoice.custom.f3 accordingly so
the modal copy is more direct.
In `@gitbooks/overview/getting-started.md`:
- Around line 38-40: The final sentence inside the warning hint is long and hard
to parse; split it into two sentences as suggested so it's clearer: in the {%
hint style="warning" %} block update the long sentence that begins "Use the
custom setup paths if you want to bring your own model, search, or Composio
credentials; some hosted features and real-time integration triggers still
require the managed backend." into two sentences (e.g., "Use the custom setup
paths if you want to bring your own model, search, or Composio credentials. Note
that some hosted features and real-time integration triggers still require the
managed backend.") so the content is easier to read while preserving the same
meaning.
In `@README.md`:
- Line 71: The sentence starting "Managed integrations are backend-proxied
through OpenHuman's Composio connector layer, so OAuth handshakes and
integration tool calls use the managed backend path by default..." is too long
and should be split for readability; replace it with two sentences such as
"Managed integrations use OpenHuman's Composio connector layer. OAuth handshakes
and integration tool calls are proxied through the managed backend by default."
and then leave the following clause about configuring direct mode with your own
Composio API key and hosting webhooks unchanged.
- Line 75: Split the combined technical-and-billing sentence about model routing
into two clear sentences: update the README's "model routing" sentence to state
that the OpenHuman backend selects and proxies the appropriate LLM for each
workload (reasoning, fast, or vision), and add a separate sentence clarifying
that one subscription includes access to all models; edit the existing paragraph
where the phrase "choose and proxy the right LLM (reasoning, fast, or vision)
under one subscription" appears to implement this separation.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d48c0cc8-485d-4b24-ab94-063ded091037
📒 Files selected for processing (5)
README.mdapp/src/lib/i18n/chunks/en-1.tsapp/src/lib/i18n/chunks/en-3.tsapp/src/lib/i18n/en.tsgitbooks/overview/getting-started.md
sunilkumarvalmiki
force-pushed
the
codex/2422-readme-backend-clarity
branch
from
61f0f6d to
1cdb854
Compare
sunilkumarvalmiki
force-pushed
the
codex/2422-readme-backend-clarity
branch
from
1cdb854 to
a14fd17
Compare
2 participants
Summary
Problem
Issue #2422 points out that current public copy can read as more local-only than the product defaults actually are. On current
main, the README leads with private/simple positioning while later default flows use hosted sign-in, model routing, search proxying, and managed Composio OAuth/tool calls. The onboarding copy also said OpenHuman could manage everything or that no personal data/messages/keys are sent to servers, which is too broad for the managed backend path.Solution
This PR keeps the current default product model, but makes the boundary explicit:
No runtime behavior changes are included.
Submission Checklist
Closes #NNN? I don't want to shit on your parade but please read the README.md and comment #2422 has broader audit/remediation asks; this PR addresses the README/onboarding clarity slice only.Impact
Documentation and English UI copy only. The user-visible effect is clearer expectation-setting during README review and onboarding/settings screens. No desktop, core, Tauri, CLI, API, performance, migration, or compatibility behavior changes.
Related
Validation Run
pnpm i18n:checkpnpm --dir app exec vitest run --config test/vitest.config.ts src/lib/i18n/__tests__/coverage.test.ts src/lib/i18n/__tests__/I18nContext.test.tsx src/pages/onboarding/__tests__/OnboardingLayout.test.tsx src/pages/onboarding/pages/__tests__/ContextPage.test.tsx? 4 files / 53 tests passedpnpm typecheckapp/node_modules/.bin/prettier.CMD --check src/lib/i18n/en.ts src/lib/i18n/chunks/en-1.ts src/lib/i18n/chunks/en-3.tsgit diff HEAD --checkValidation Blocked
command:git push fork HEAD:refs/heads/codex/2422-readme-backend-claritywithout--no-verifyerror:pre-push hook runs broader repository checks;cargo check --manifest-path app/src-tauri/Cargo.tomlfailed becauseapp/src-tauri/vendor/tauri-cef/crates/tauri/Cargo.tomlis missing in this worktree, andlint:commands-tokensfails on existing command-token guard output outside this diff.impact:unrelated to this docs/copy change; branch was pushed with--no-verifyafter the focused validation above passed.Behavior Changes
Summary by CodeRabbit