Skip to content

Feat/docs v6#1387

Merged
senamakel merged 9 commits into
tinyhumansai:mainfrom
senamakel:feat/docs-v6
May 9, 2026
Merged

Feat/docs v6#1387
senamakel merged 9 commits into
tinyhumansai:mainfrom
senamakel:feat/docs-v6

Conversation

@senamakel
Copy link
Copy Markdown
Member

@senamakel senamakel commented May 9, 2026

Summary

  • What changed and why.
  • Keep this to 3-6 bullets focused on user-visible or architecture-impacting changes.

Problem

  • What issue or risk this PR addresses.
  • Include context needed for reviewers to evaluate correctness quickly.

Solution

  • How the implementation solves the problem.
  • Note important design decisions and tradeoffs.

Submission Checklist

If a section does not apply to this change, mark the item as N/A with a one-line reason. Do not delete items.

  • Tests added or updated (happy path + at least one failure / edge case) per Testing Strategy
  • Diff coverage ≥ 80% — changed lines (Vitest + cargo-llvm-cov merged via diff-cover) meet the gate enforced by .github/workflows/coverage.yml. Run pnpm test:coverage and pnpm test:rust locally; PRs below 80% on changed lines will not merge.
  • Coverage matrix updated — added/removed/renamed feature rows in docs/TEST-COVERAGE-MATRIX.md reflect this change (or N/A: behaviour-only change)
  • All affected feature IDs from the matrix are listed in the PR description under ## Related
  • No new external network dependencies introduced (mock backend used per Testing Strategy)
  • Manual smoke checklist updated if this touches release-cut surfaces (docs/RELEASE-MANUAL-SMOKE.md)
  • Linked issue closed via Closes #NNN in the ## Related section

Impact

  • Runtime/platform impact (desktop/mobile/web/CLI), if any.
  • Performance, security, migration, or compatibility implications.

Related

  • Closes:
  • Follow-up PR(s)/TODOs:

AI Authored PR Metadata (required for Codex/Linear PRs)

Keep this section for AI-authored PRs. For human-only PRs, mark each field N/A.

Linear Issue

  • Key:
  • URL:

Commit & Branch

  • Branch:
  • Commit SHA:

Validation Run

  • pnpm --filter openhuman-app format:check
  • pnpm typecheck
  • Focused tests:
  • Rust fmt/check (if changed):
  • Tauri fmt/check (if changed):

Validation Blocked

  • command:
  • error:
  • impact:

Behavior Changes

  • Intended behavior change:
  • User-visible effect:

Parity Contract

  • Legacy behavior preserved:
  • Guard/fallback/dispatch parity checks:

Duplicate / Superseded PR Handling

  • Duplicate PR(s):
  • Canonical PR:
  • Resolution (closed/superseded/updated):

Summary by CodeRabbit

  • Documentation
    • New, user-facing guides for native tools and features (Web Search, Web Scraper, Coder, Browser & Computer Control, Voice, Memory Tools, Cron & Scheduling, Third‑party Integrations, Agent Coordination).
    • Added architecture and agent-harness documentation and expanded Memory Tree / memory-graph content.
    • Reorganized navigation/TOC and refreshed related overview pages; removed or consolidated a few older docs.

senamakel and others added 7 commits May 8, 2026 23:26
…into subpages

- Fold memory-tree-pipeline.md into memory-tree.md as a high-level
  'How the pipeline works' section (no code/file refs).
- Replace single-page native-tools.md and voice.md with
  features/native-tools/ directory: README + subpages for web search,
  scraper, coder, browser & computer, cron, voice, memory tools,
  third-party integrations, agent coordination, system & utilities.
- Update SUMMARY.md and all cross-links.
Documents the full turn lifecycle, tool-call loop, sub-agent / orchestrator
pattern, archetype catalog, trigger triage, mid-turn stop hooks, post-turn
hooks, interrupts, cost accounting, and KV-cache fork context.
@senamakel senamakel requested a review from a team May 9, 2026 06:34
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 9, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 79cbeab2-8ee0-41fe-b904-e318d5ea2207

📥 Commits

Reviewing files that changed from the base of the PR and between 072bac9 and 1749073.

📒 Files selected for processing (12)
  • gitbooks/README.md
  • gitbooks/SUMMARY.md
  • gitbooks/developing/architecture/README.md
  • gitbooks/features/integrations.md
  • gitbooks/features/mascot.md
  • gitbooks/features/model-routing/README.md
  • gitbooks/features/model-routing/local-ai.md
  • gitbooks/features/native-tools/README.md
  • gitbooks/features/native-tools/voice.md
  • gitbooks/features/platform.md
  • gitbooks/features/privacy-and-security.md
  • gitbooks/overview/how-it-works.md

📝 Walkthrough

Walkthrough

This PR reorganizes GitBook docs: creates a native-tools subtree with granular tool-family pages, adds Agent Harness runtime documentation, expands Memory Tree architecture, updates internal links to the new structure, and consolidates/removed several legacy doc pages.

Changes

Documentation Hierarchy Restructuring

Layer / File(s) Summary
Navigation and Structure
README.md, gitbooks/README.md, gitbooks/SUMMARY.md
Root README enhanced with a memory-graph highlight; GitBook feature overview split into emphasized blocks; SUMMARY reorganized with Native Tools subtree and Agent Harness entry.
Agent Harness Runtime Documentation
gitbooks/developing/architecture/agent-harness.md
New 277-line page describing agent harness runtime scope, Agent::turn hot path and KV-cache reuse, tool-call loop with context mitigation, ToolMaker self-healing, orchestrator multi-agent patterns, trigger triage, hooks and interrupts, cost accounting, and code navigation.
Native Tools Index
gitbooks/features/native-tools/README.md
New index page listing native tool families with links to subpages and cross-references (token compression, integrations, privacy).
Web Discovery Tools
gitbooks/features/native-tools/web-search.md, gitbooks/features/native-tools/web-scraper.md
Web Search (server-side proxy discovery, titles/snippets/URLs) and Web Scraper (cleaned article text, 1 MB cap, 20s timeout, proxy/URL-guard rules).
Filesystem and System Tools
gitbooks/features/native-tools/coder.md, gitbooks/features/native-tools/system-and-utilities.md
Coder tools (file read/write, edits, patches, git ops, lint/test runners, CSV export, workspace scoping) and System & Utilities (shell/node/npm exec, time, schedule, notifications, DB helpers, LSP, workspace state, proxy config, tool stats).
Browser and Scheduling Tools
gitbooks/features/native-tools/browser-and-computer.md, gitbooks/features/native-tools/cron.md
Browser & Computer Control (CEF browser actions, screenshots, human-like mouse/keyboard) and Cron & Scheduling (recurring jobs, reminders, cron toolset, run history).
Voice, Memory, and Coordination
gitbooks/features/native-tools/voice.md, gitbooks/features/native-tools/memory-tools.md, gitbooks/features/native-tools/agent-coordination.md
Voice (STT/TTS, hosted TTS, Google Meet agent, privacy), Memory Tools (recall/store/forget, tree-aware retrieval), and Agent Coordination (planning, delegation, subagents, clarification).
Third-party Integrations
gitbooks/features/native-tools/integrations.md
Documentation for 118+ proxied integrations (OAuth, native providers vs proxied-only, backend proxy privacy boundary, token handling).
Memory Tree Architecture
gitbooks/features/obsidian-wiki/memory-tree.md
Expanded pipeline description with explicit store/score/trees stages, job kinds and retry/dedupe/stale-lock behavior, worker startup/lease recovery and LLM throttling, chunk lifecycle state machine, daily scheduler, RPC ingest endpoint, and Intelligence tab UI subsections; consolidates removed pipeline doc content.
Cross-Reference Updates
gitbooks/developing/cef.md, gitbooks/features/integrations.md, gitbooks/features/privacy-and-security.md, gitbooks/features/token-compression.md, gitbooks/overview/how-it-works.md
Updated links to native-tools/README.md and native-tools/voice.md, removed explicit ElevenLabs mentions in favor of hosted TTS wording, and refined privacy/workspace-scoping link targets.
File Consolidation
gitbooks/features/native-tools.md (removed), gitbooks/features/obsidian-wiki/memory-tree-pipeline.md (removed), gitbooks/features/voice.md (removed)
Monolithic native-tools.md, memory-tree-pipeline.md, and voice.md content consolidated into the new native-tools subtree and expanded memory-tree page; legacy files removed.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Poem

🐰 A warren of docs, now neatly organized,
Native tools split and thoughtfully revised,
Agent Harness hums through every new turn,
Memory Tree grows so the agent can learn,
Cross-links woven tight — the docs are unified!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Feat/docs v6' is vague and generic, using non-descriptive phrasing that does not convey the actual scope or content of the changeset. Replace with a more descriptive title that reflects the main documentation restructuring, such as 'Refactor native tools documentation into modular subpages' or 'Reorganize documentation structure with native-tools directory and agent-harness architecture'.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.


Comment @coderabbitai help to get the list of available commands and usage tips.

@senamakel senamakel merged commit 5870b22 into tinyhumansai:main May 9, 2026
10 of 12 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request May 13, 2026
12 tasks
AusAgentSmith pushed a commit to AusAgentSmith/openhuman that referenced this pull request May 23, 2026
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