Feat/docs v7#1390
Merged
Merged
Conversation
Introduce features/mascot/ with a README porting the Mascot overview from the future docs branch, plus a new meeting-agents.md detailing how the mascot joins Google Meet as a real participant — listening, speaking, animating the camera feed, and using tools mid-call (the differentiator vs. a passive notetaker).
…em-dashes - Rewrite overview/getting-started.md around the actual onboarding flow (Welcome → Connect Gmail → Building profile → Choose how AI runs → Referral), drop the stale "Skills & Integrations" tail, point to Meeting Agents / Auto-fetch / Voice / Subconscious instead. - Add description frontmatter to the 9 pages that were missing one (how-it-works, all three settings-reference, features/architecture, features/platform, features/privacy-and-security, both legal pages). - Replace every em-dash with a hyphen across all gitbooks pages.
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (19)
📝 WalkthroughWalkthroughThis PR introduces comprehensive new Mascot and Meeting Agents feature documentation, adds Triggers event handling documentation, rewrites the user onboarding flow, restructures GitBook navigation, standardizes 35+ documentation files with consistent typography (em-dash to hyphen), updates internal documentation link paths to directory-based structure, replaces ASCII diagrams with Mermaid flowcharts, and adds YAML frontmatter metadata to legal and feature pages. ChangesNew Mascot and Meeting Agents Features
Navigation and Structure Updates
Onboarding and Product Messaging
Architecture and Documentation Metadata
Memory and Integration Feature Documentation
Native Tools and Feature Documentation
Feature and Supporting Documentation
Contributor Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
gitbooks/legal/privacy-policy.md (1)
72-72:⚠️ Potential issue | 🟠 Major | ⚡ Quick winReplace the email domain placeholder before production use.
The privacy contact email contains a placeholder
[yourdomain]that must be replaced with the actual domain. Users need a valid contact method to exercise their privacy rights under GDPR, CCPA, DPDP, and other regulations mentioned in this policy.📧 Suggested fix
Replace the placeholder with the actual domain, for example:
-Requests can be done on the dashboard at any time or may be submitted to privacy@\[yourdomain].com. +Requests can be done on the dashboard at any time or may be submitted to privacy@openhuman.ai.🤖 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/legal/privacy-policy.md` at line 72, Update the placeholder privacy contact email in the privacy-policy.md line that currently reads privacy@[yourdomain].com to the real support/legal email for production (e.g., privacy@yourcompany.com); ensure the exact string "privacy@[yourdomain].com" is replaced, verify the mailto/markdown formatting if used, and search the document for any other occurrences of "[yourdomain]" to replace them consistently with the correct production domain.gitbooks/legal/terms-of-use.md (1)
56-56:⚠️ Potential issue | 🔴 Critical | ⚡ Quick winReplace the jurisdiction placeholder before production use.
The governing law section contains a placeholder
[Insert Jurisdiction]that must be replaced with the actual legal jurisdiction. Legal documents with placeholders cannot provide valid user protection and should not be deployed.⚖️ Suggested fix
Replace the placeholder with the actual jurisdiction, for example:
-These Terms are governed by the laws of \[Insert Jurisdiction], without regard to conflict of law principles. +These Terms are governed by the laws of [Actual Jurisdiction, e.g., "the State of California"], without regard to conflict of law principles.🤖 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/legal/terms-of-use.md` at line 56, Replace the placeholder in the governing law sentence "These Terms are governed by the laws of [Insert Jurisdiction], without regard to conflict of law principles." with the actual jurisdiction to be used in production (e.g., "the laws of California, USA" or the appropriate country/state), ensuring the bracketed placeholder is fully removed and the text reads as a valid jurisdictional clause in gitbooks/legal/terms-of-use.md.
🤖 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 `@gitbooks/features/model-routing.md`:
- Line 3: The sentence "One subscription, many models. Tasks pick their model
via hint prefixes -" in model-routing.md uses a single hyphen incorrectly;
replace the trailing single hyphen with a double-hyphen ("--") or restructure
the line (e.g., use a colon or separate clause) so it reads as proper plain-text
punctuation; apply the same double-hyphen convention across other GitBook pages
if the hyphen substitution was used project-wide to keep documentation
consistent.
In `@gitbooks/overview/getting-started.md`:
- Line 77: The two docs conflict on Gmail auto-fetch timing; update the sentence
in getting-started.md ("Once Gmail has been ingested (the first auto-fetch tick
happens within five minutes), try prompts like:") to match the canonical
behavior described in gitbooks/features/privacy-and-security.md by changing
"five minutes" to "15 minutes" (or add a clarifying clause that the default sync
interval is 15 minutes and any shorter initial fetch depends on configuration)
so both files state the same default timing.
- Line 45: The sentence "After sign-in, OpenHuman runs you through a short
routed onboarding under `/onboarding/*`. The flow is intentionally tiny - three
real steps, then you're in." is inconsistent with the page which outlines Step 1
through Step 5; update that sentence to reflect five steps (e.g., replace "three
real steps" with "five steps" or "five short steps") so the intro matches the
Step 1–Step 5 headings and copy.
---
Outside diff comments:
In `@gitbooks/legal/privacy-policy.md`:
- Line 72: Update the placeholder privacy contact email in the privacy-policy.md
line that currently reads privacy@[yourdomain].com to the real support/legal
email for production (e.g., privacy@yourcompany.com); ensure the exact string
"privacy@[yourdomain].com" is replaced, verify the mailto/markdown formatting if
used, and search the document for any other occurrences of "[yourdomain]" to
replace them consistently with the correct production domain.
In `@gitbooks/legal/terms-of-use.md`:
- Line 56: Replace the placeholder in the governing law sentence "These Terms
are governed by the laws of [Insert Jurisdiction], without regard to conflict of
law principles." with the actual jurisdiction to be used in production (e.g.,
"the laws of California, USA" or the appropriate country/state), ensuring the
bracketed placeholder is fully removed and the text reads as a valid
jurisdictional clause in gitbooks/legal/terms-of-use.md.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: efcb0ece-5d8c-4e34-8bd0-46c4086bdded
📒 Files selected for processing (32)
gitbooks/SUMMARY.mdgitbooks/developing/README.mdgitbooks/developing/architecture.mdgitbooks/developing/cef.mdgitbooks/developing/cloud-deploy.mdgitbooks/developing/coding-harness.mdgitbooks/developing/frontend.mdgitbooks/developing/getting-set-up.mdgitbooks/developing/release-policy.mdgitbooks/developing/tauri-shell.mdgitbooks/developing/testing-strategy.mdgitbooks/features/architecture.mdgitbooks/features/integrations.mdgitbooks/features/local-ai.mdgitbooks/features/mascot/README.mdgitbooks/features/mascot/meeting-agents.mdgitbooks/features/model-routing.mdgitbooks/features/native-tools.mdgitbooks/features/obsidian-wiki/memory-tree-pipeline.mdgitbooks/features/obsidian-wiki/memory-tree.mdgitbooks/features/platform.mdgitbooks/features/privacy-and-security.mdgitbooks/features/subconscious.mdgitbooks/features/token-compression.mdgitbooks/features/voice.mdgitbooks/legal/privacy-policy.mdgitbooks/legal/terms-of-use.mdgitbooks/overview/getting-started.mdgitbooks/overview/how-it-works.mdgitbooks/settings-reference/account-and-security.mdgitbooks/settings-reference/ai-and-skills.mdgitbooks/settings-reference/automation-and-channels.md
| ## 4. Run your first request | ||
|
|
||
| Once a source is connected and auto-fetch has run a tick, try prompts like: | ||
| Once Gmail has been ingested (the first auto-fetch tick happens within five minutes), try prompts like: |
Contributor
There was a problem hiding this comment.
Auto-fetch timing conflicts with another doc in this PR.
This line says first ingest happens within five minutes, but gitbooks/features/privacy-and-security.md states Gmail sync is every 15 minutes by default. Please make both docs agree to avoid user confusion.
Suggested edit
-Once Gmail has been ingested (the first auto-fetch tick happens within five minutes), try prompts like:
+Once Gmail has been ingested (based on your configured auto-fetch interval), try prompts like:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| Once Gmail has been ingested (the first auto-fetch tick happens within five minutes), try prompts like: | |
| Once Gmail has been ingested (based on your configured auto-fetch interval), try prompts like: |
🤖 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` at line 77, The two docs conflict on
Gmail auto-fetch timing; update the sentence in getting-started.md ("Once Gmail
has been ingested (the first auto-fetch tick happens within five minutes), try
prompts like:") to match the canonical behavior described in
gitbooks/features/privacy-and-security.md by changing "five minutes" to "15
minutes" (or add a clarifying clause that the default sync interval is 15
minutes and any shorter initial fetch depends on configuration) so both files
state the same default timing.
# Conflicts: # gitbooks/SUMMARY.md # gitbooks/developing/README.md # gitbooks/developing/architecture/frontend.md # gitbooks/developing/coding-harness.md # gitbooks/features/model-routing/local-ai.md # gitbooks/features/native-tools.md # gitbooks/features/obsidian-wiki/memory-tree-pipeline.md # gitbooks/features/obsidian-wiki/memory-tree.md # gitbooks/features/privacy-and-security.md # gitbooks/features/subconscious.md # gitbooks/features/voice.md # gitbooks/overview/getting-started.md # gitbooks/overview/how-it-works.md # gitbooks/settings-reference/account-and-security.md # gitbooks/settings-reference/ai-and-skills.md # gitbooks/settings-reference/automation-and-channels.md
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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 `@gitbooks/features/mascot/README.md`:
- Line 15: The heading "It speaks, and lip-syncs to its own voice" is currently
level 3 (###) and causes a markdown lint MD001 because it jumps from h1 to h3;
change that heading to level 2 (## It speaks, and lip-syncs to its own voice) or
insert an appropriate level 2 heading above it so the document uses a proper h1
→ h2 → h3 hierarchy; locate the line containing that exact heading text in
README.md and update the markup accordingly.
In `@gitbooks/features/privacy-and-security.md`:
- Line 67: Update the image src string in
gitbooks/features/privacy-and-security.md: replace the current src value "V17 -
Privacy Shield@2x.png" with the exact asset filename containing the em-dash "V17
— Privacy Shield@2x.png" so the <img> tag references the correct file and the
image loads.
In `@README.md`:
- Around line 60-72: Fix the copy typos and grammar in the README intro: change
"Insipired" to "Inspired" (in the phrase "Insipired by [Karpathy's LLM
Knowledgebase]") and correct "chunks that is stored into a Karpathy-style" to
"chunks that are stored in a Karpathy-style" or "chunks stored in a
Karpathy-style" (the sentence "The Memory Tree compresses everything into
Markdown chunks that is stored into a Karpathy-style [Obsidian wiki]"
specifically). Also adjust the verb agreement in "OpenHuman summarizes and
compress all your documents" to "summarizes and compresses all your documents"
to match subject-verb agreement. Ensure these exact phrases are updated in
README.md.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 89ea8ce0-ddde-4b82-a30b-15476d99389a
📒 Files selected for processing (31)
README.mdgitbooks/README.mdgitbooks/SUMMARY.mdgitbooks/developing/README.mdgitbooks/developing/architecture/README.mdgitbooks/developing/architecture/agent-harness.mdgitbooks/developing/architecture/frontend.mdgitbooks/developing/architecture/tauri-shell.mdgitbooks/developing/cef.mdgitbooks/features/cloud-deploy.mdgitbooks/features/integrations.mdgitbooks/features/mascot/README.mdgitbooks/features/mascot/meeting-agents.mdgitbooks/features/model-routing/README.mdgitbooks/features/model-routing/local-ai.mdgitbooks/features/native-tools/README.mdgitbooks/features/native-tools/agent-coordination.mdgitbooks/features/native-tools/browser-and-computer.mdgitbooks/features/native-tools/coder.mdgitbooks/features/native-tools/cron.mdgitbooks/features/native-tools/integrations.mdgitbooks/features/native-tools/memory-tools.mdgitbooks/features/native-tools/system-and-utilities.mdgitbooks/features/native-tools/voice.mdgitbooks/features/native-tools/web-scraper.mdgitbooks/features/native-tools/web-search.mdgitbooks/features/obsidian-wiki/memory-tree.mdgitbooks/features/platform.mdgitbooks/features/privacy-and-security.mdgitbooks/features/token-compression.mdgitbooks/overview/getting-started.md
✅ Files skipped from review due to trivial changes (23)
- gitbooks/features/model-routing/README.md
- gitbooks/features/cloud-deploy.md
- gitbooks/features/native-tools/README.md
- gitbooks/developing/architecture/README.md
- gitbooks/features/native-tools/browser-and-computer.md
- gitbooks/features/native-tools/web-search.md
- gitbooks/features/native-tools/system-and-utilities.md
- gitbooks/features/integrations.md
- gitbooks/features/native-tools/coder.md
- gitbooks/features/native-tools/cron.md
- gitbooks/features/native-tools/integrations.md
- gitbooks/features/token-compression.md
- gitbooks/developing/cef.md
- gitbooks/README.md
- gitbooks/developing/architecture/frontend.md
- gitbooks/features/native-tools/voice.md
- gitbooks/features/native-tools/web-scraper.md
- gitbooks/developing/architecture/tauri-shell.md
- gitbooks/features/model-routing/local-ai.md
- gitbooks/features/native-tools/memory-tools.md
- gitbooks/SUMMARY.md
- gitbooks/features/native-tools/agent-coordination.md
- gitbooks/developing/README.md
🚧 Files skipped from review as they are similar to previous changes (1)
- gitbooks/features/platform.md
- New features/integrations/triggers.md covering live integration events, the triage classifier (drop / acknowledge / react / escalate), and how a trigger can fire a full agent action via Trigger Reactor or Orchestrator. - Convert features/integrations.md to a directory; relink every reference across the docs. - Fix awkward " - " in features/model-routing/README.md description (use a colon instead). - Fix overview/getting-started.md: onboarding intro now says "five short steps" to match the Step 1-5 headings. - Replace privacy@[yourdomain].com placeholder in legal/privacy-policy.md with privacy@tinyhumans.ai (the production domain used elsewhere). Skipped: - Terms of Use jurisdiction placeholder: needs legal/business decision, not a doc fix. - Auto-fetch timing in getting-started.md: already says "twenty minutes", matching the canonical features/obsidian-wiki/auto-fetch.md (the 15-min figure in privacy-and-security.md is the per-Gmail-provider sync interval, not the global auto-fetch tick). - Project-wide " - " to "--" sweep: would mangle headings/labels; the only awkward instance flagged was fixed in place.
GitBook renders Unicode box-drawing characters (┌─│└▼) inconsistently in plain code fences. Convert the three diagrams in the Obsidian-Wiki section to Mermaid (auto-fetch loop, ingest pipeline, leaf lifecycle) so they render natively on the published site.
- features/mascot/README.md: add a "What it does" h2 and promote "Why have a mascot at all?" to h2 so headings go h1 → h2 → h3 (fixes MD001). - features/privacy-and-security.md: fix the V17 Privacy Shield image src to use the em-dash filename that actually exists in gitbooks/.gitbook/assets/. - README.md: typo fixes - "Insipired" → "Inspired", subject-verb agreement on "summarizes and compresses", and rephrase "chunks that is stored into" → "chunks stored in".
AusAgentSmith
pushed a commit
to AusAgentSmith/openhuman
that referenced
this pull request
May 23, 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
Problem
Solution
Submission Checklist
diff-cover) meet the gate enforced by.github/workflows/coverage.yml. Runpnpm test:coverageandpnpm test:rustlocally; PRs below 80% on changed lines will not merge.docs/TEST-COVERAGE-MATRIX.mdreflect this change (orN/A: behaviour-only change)## Relateddocs/RELEASE-MANUAL-SMOKE.md)Closes #NNNin the## RelatedsectionImpact
Related
AI Authored PR Metadata (required for Codex/Linear PRs)
Linear Issue
Commit & Branch
Validation Run
pnpm --filter openhuman-app format:checkpnpm typecheckValidation Blocked
command:error:impact:Behavior Changes
Parity Contract
Duplicate / Superseded PR Handling
Summary by CodeRabbit
Documentation