docs(gitbooks v5): restructure features, simplify subconscious, README polish, default auto-fetch to 20 min#1386
Merged
Merged
Conversation
The runtime code (src/main.rs::resolve_environment, app/src-tauri's resolve_sentry_environment, cef_profile::default_root_dir_name, app/src/utils/config.ts) already treats production as the default when OPENHUMAN_APP_ENV is unset — the only thing pointing new contributors at staging was .env.example itself. Comment out OPENHUMAN_APP_ENV / VITE_OPENHUMAN_APP_ENV / BACKEND_URL / VITE_BACKEND_URL in .env.example and app/.env.example so a fresh copy of the example file resolves to production through the runtime defaults. Uncomment + set staging only when you actually want the staging backend. Also fix gitbooks/developing/cloud-deploy.md which incorrectly documented the default as 'staging'.
The Use Cases pages were thin and duplicated framing already covered by the feature pages and the Welcome doc. Remove the directory and the matching SUMMARY.md section.
The chapter-per-file structure under gitbooks/developing/frontend/ and gitbooks/developing/tauri-shell/ was hard to scan and made the sidebar long. Concatenate each set into one consolidated page with each former chapter as a top-level section: - gitbooks/developing/frontend.md (architecture, state, services, providers, pages & routing, components, hooks & utilities) - gitbooks/developing/tauri-shell.md (architecture, IPC commands, core bridge & helpers) Strip the per-chapter "Previous / Next" navigation footers since they no longer make sense, and rewire the few cross-links that pointed at the old chapter paths. Update SUMMARY.md, CLAUDE.md, AGENTS.md, and .claude/rules/README.md to point at the new flat paths.
The Product section duplicated framing already covered by feature pages — Skills & Integrations re-explained third-party integrations, Intelligence re-explained the Memory Tree UI, Messaging Channels was a paragraph that fits inside the integrations doc, and Cloud Deploy / Subconscious / Architecture had drifted between Product and Developing. Net moves: - features/integrations.md absorbs skills-and-integrations.md and messaging-channels.md (new "Messaging channels" + "Skills" + "Native voice and tools" sections + a "How connections work" status table). - features/obsidian-wiki/memory-tree.md absorbs intelligence.md (new "In the desktop app — the Intelligence tab" section). - product/architecture.md, platform.md, privacy-and-security.md, subconscious.md -> features/. - product/cloud-deploy.md -> developing/cloud-deploy.md (it was always a contributor doc). - product/intelligence.md, messaging-channels.md, skills-and- integrations.md deleted (content merged). - gitbooks/product/ directory removed entirely. Update SUMMARY.md (drop Product section, fold pages into Features and Developing), README.md (rewire the messaging- channels / privacy & security links), gitbooks/README.md, the overview/getting-started + overview/how-it-works cross-links, and developing/README.md (point Subconscious + high-level Architecture at the new locations).
…ce em-dashes - Repoint repo-root references that go up one level too few from inside gitbooks/developing/ (../docs -> ../../docs, ../.do -> ../../.do, ../.github -> ../../.github, ../src -> ../../src, ../docker-compose.yml -> ../../docker-compose.yml). - Repoint cross-links that survived the frontend/tauri-shell flattening: ../frontend/services.md -> frontend.md#services-layer, ../ARCHITECTURE.md -> architecture.md, ../src-tauri/01-architecture.md -> tauri-shell.md. - Strip /broken/pages/<id> placeholders that the GitBook UI left behind for since-deleted pages (Skills, Conscious Loop, Webview Integration, Memory Context Window, Install, Auto-update). - Drop the SKILL-WORKING-MEMORY paragraph in developing/architecture.md (target file deleted). - Delete duplicate gitbooks/overview/platform.md (only features/platform.md is in SUMMARY). - Reduce em-dashes 311 -> 61 across prose (skip code fences, tables, frontmatter, headings, horizontal rules). After this pass, gitbooks/ has 0 broken internal links and 0 stale GitHub blob/tree links.
…ve content clarity - Replaced outdated images in README.md and gitbooks/README.md with a new demo image. - Reformatted the product comparison table for better readability. - Removed several obsolete screenshot files to streamline assets.
- TICK_SECONDS 300 → 1200 (composio/periodic.rs); bump test upper bound to 3600 - Update README + gitbooks references from 5 min to 20 min - Add "Memory in minutes, not weeks" section contrasting OpenHuman's connect-and-sync flow with cold-start agents (Hermes, OpenClaw)
…I into one Batteries included bullet
- Nest auto-fetch under integrations (features/integrations/auto-fetch.md) - Nest local-ai under model-routing (features/model-routing/local-ai.md) - Remove settings-reference section (account-and-security, ai-and-skills, automation-and-channels) - Strip code/RPC references from subconscious page; keep concepts high-level - README: replace em-dashes, drop "One subscription, many providers" bullet, merge native tools/voice/routing/local-ai into "Batteries included", combine integrations + auto-fetch into one bullet, expand TokenJuice description with concrete compaction examples - Update all cross-links to the new paths
…oping overview - Remove 29 unreferenced files from gitbooks/.gitbook/assets/ (only demo.png, image.png, V17 — Privacy Shield@2x.png, memory-tree-pipeline (1).excalidraw still in use) - Fix broken V17 image reference in features/privacy-and-security.md (period → em-dash to match the actual filename) - Rewrite developing/README.md: regroup pages by intent (Start here / Testing / Shipping / Going deeper / Contributing), update yarn → pnpm, drop dead docs/ links
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (28)
📒 Files selected for processing (26)
📝 WalkthroughWalkthroughThis PR updates the periodic auto-fetch scheduler interval from 5 to 20 minutes in both code and documentation, reorganizes GitBook documentation structure with nested feature sections, removes three legacy settings-reference pages, rewrites subconscious loop documentation from implementation-focused to conceptual, enhances the pre-push Git hook with signal handling, and harmonizes cross-reference paths throughout the feature documentation set. ChangesAuto-fetch Scheduler Implementation & Cadence Updates
Documentation Architecture & Content Restructuring
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
Comment |
Each pnpm step was wrapped in 'set +e; pnpm ...; EXIT=$?; set -e'. When Ctrl+C killed the running pnpm (exit 130), the capture treated it as a normal failure and ran the next step. Add an INT/TERM trap that kills the process group and exits 130 so interrupts actually stop the hook.
AusAgentSmith
pushed a commit
to AusAgentSmith/openhuman
that referenced
this pull request
May 23, 2026
…E polish, default auto-fetch to 20 min (tinyhumansai#1386)
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
GitBooks + README docs pass, plus a small core default change.
TICK_SECONDS300 → 1200 insrc/openhuman/composio/periodic.rs(test upper bound bumped to 3600). All docs updated to match.Test plan
Summary by CodeRabbit
Documentation
Bug Fixes