docs: gitbooks v3 — flatten frontend/tauri-shell, kill product/, fix links, default app env to production#1385
Merged
senamakel merged 7 commits intoMay 9, 2026
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.
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 (5)
📒 Files selected for processing (60)
📝 WalkthroughWalkthroughThis PR consolidates GitBook documentation by merging fragmented frontend and Tauri shell docs into single comprehensive reference pages, restructures the table of contents by removing Product and Use Cases sections, updates environment variable guidance to make values optional with documented defaults, and applies minor wording refinements across feature documentation. ChangesDocumentation Consolidation & Restructuring
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
|
This was referenced May 9, 2026
Merged
Merged
AusAgentSmith
pushed a commit
to AusAgentSmith/openhuman
that referenced
this pull request
May 23, 2026
…links, default app env to production (tinyhumansai#1385)
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/use-cases/entirely.OPENHUMAN_APP_ENVto production in.env.example. The runtime code already defaults to production; only the example envs were nudging contributors to staging. Comment those lines +BACKEND_URL/VITE_BACKEND_URLso a fresh.envresolves to production. Also fix the cloud-deploy doc that incorrectly said "Defaults tostaging".developing/frontend/anddeveloping/tauri-shell/into single pages. The chapter-per-file structure made the sidebar long and hard to scan. Concatenate each set intodeveloping/frontend.md(architecture / state / services / providers / pages & routing / components / hooks) anddeveloping/tauri-shell.md(architecture / IPC commands / core bridge). Strip per-chapter "Previous / Next" footers and rewire internal cross-links.gitbooks/product/intogitbooks/features/. Skills & Integrations + Messaging Channels merge intofeatures/integrations.md(new "How connections work", "Messaging channels", "Skills" sections). Intelligence merges intofeatures/obsidian-wiki/memory-tree.md(new "In the desktop app — the Intelligence tab" section).architecture.md,platform.md,privacy-and-security.md,subconscious.mdmove tofeatures/.cloud-deploy.mdmoves back todeveloping/(it was always a contributor doc). Theproduct/directory is removed entirely.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 dead/broken/pages/<id>placeholders for since-deleted pages..gitbook/assets/(drop 31 unused images, compress the remaining 5 withpngquant, normalize a U+202F filename — directory shrunk 34M → 2.6M). Refresh README hero image, drop the duplicate "highlights" section in favor of links inline in "What is OpenHuman".Problem
.env.exampletold new contributors to use staging, even though the runtime code defaults to production.developing/frontend/anddeveloping/tauri-shell/chapter directories made the sidebar noisy and the navigation circuitous.product/section overlapped heavily withfeatures/(Skills & Integrations duplicating Integrations, Intelligence duplicating Memory Tree UI, Messaging Channels being a paragraph that fits inside Integrations)./broken/pages/<id>placeholders from the GitBook UI when files were renamed.Solution
.do/app.yaml, the PR template, source-code comments referencing moved paths) plus the.env.exampledefaults.Submission Checklist
Impact
maininapp/src/features/human/Mascot/yellow/MascotCharacter.tsx(Cannot find module '@remotion/zod-types'/'remotion'), unchanged on this branch. Pushed with--no-verifyper the project's pre-push policy inCLAUDE.md.Related
AI Authored PR Metadata (required for Codex/Linear PRs)
Linear Issue
Commit & Branch
docs/flatten-frontend-tauri-shellValidation Run
pnpm --filter openhuman-app format:checkpnpm typecheck— pre-existing breakage onmain, untouched in this PR.cargo fmt --manifest-path Cargo.toml --all --checkcargo fmt --manifest-path app/src-tauri/Cargo.toml --all --checkValidation Blocked
command:pnpm compileerror:Cannot find module '@remotion/zod-types' or its corresponding type declarations.inapp/src/features/human/Mascot/yellow/MascotCharacter.tsximpact:Pre-existing onmain. No code in this PR touches that file or its imports.Behavior Changes
.env.exampleresolves to production by default.Parity Contract
Duplicate / Superseded PR Handling
Summary by CodeRabbit
.env.examplefiles, marking optional variables as commented examples with clear defaults documented.