Skip to content

Feat/docs v9#1392

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

Feat/docs v9#1392
senamakel merged 11 commits into
tinyhumansai:mainfrom
senamakel:feat/docs-v9

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
    • Enhanced auto-fetch documentation with clearer flow diagrams.
    • Improved Memory Tree documentation with better pipeline visualizations.

Review Change Stack

senamakel added 11 commits May 8, 2026 23:59
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.
# 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
- 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".
GitBook's Mermaid renderer was misbehaving on these blocks. Switch to plain
ASCII (only |, v, +, -, /, \) inside untagged code fences so they render
cleanly as monospace preformatted text. Avoids Unicode box-drawing chars,
which were the original problem.
@senamakel senamakel requested a review from a team May 9, 2026 07:27
@senamakel senamakel merged commit f598f36 into tinyhumansai:main May 9, 2026
14 of 16 checks passed
@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: d6a7a943-bd09-4455-bc81-830da0bcc80e

📥 Commits

Reviewing files that changed from the base of the PR and between b02916d and 89e33a0.

📒 Files selected for processing (2)
  • gitbooks/features/obsidian-wiki/auto-fetch.md
  • gitbooks/features/obsidian-wiki/memory-tree.md

📝 Walkthrough

Walkthrough

This PR updates documentation for two Obsidian Wiki features. The auto-fetch scheduler documentation now explicitly describes the periodic 20-minute sync cycle, per-connection state checks, and conditional provider invocation. The memory-tree documentation expands the ingestion pipeline into a step-by-step flow and clarifies the leaf lifecycle state transitions.

Changes

Documentation Improvements for Obsidian Wiki Features

Layer / File(s) Summary
Auto-fetch Scheduler Control Flow
gitbooks/features/obsidian-wiki/auto-fetch.md
Periodic sync scheduler documentation clarified with explicit description of the 20-minute tick, per-connection sync state components (toolkit, connection_id, last sync timestamp, daily budget, dedup set, cursor), conditional provider.sync() calls, and successful timestamp recording.
Memory-tree Ingestion Pipeline
gitbooks/features/obsidian-wiki/memory-tree.md
Core ingestion pipeline expanded from diagram to step-by-step written flow covering source adapters → canonicalize → chunker → content_store → store → score → per-scope trees → retrieval.
Memory-tree Leaf Lifecycle
gitbooks/features/obsidian-wiki/memory-tree.md
Leaf state lifecycle updated from Mermaid flowchart to ASCII state progression showing transitions: pending_extraction → admitted → buffered → sealed, with optional dropped terminal branch.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit hops through docs so bright,
With diagrams revised for clarity's light,
States flow and pipelines now aligned,
The scheduler's dance at last defined! 🐰✨


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

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