docs: humanize the documentation set and restructure the gitbook - #238
Conversation
Co-authored-by: Medulla <medulla@tinyhumans.ai>
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Your trial has ended. Reactivate Greptile to resume code reviews.
|
Warning Review limit reachedYou’ve reached a temporary PR review limit under our Fair Usage Limits Policy. Next review available in: 50 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (39)
Comment |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1d3b0f2a51
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| An index of every environment variable Medulla reads, what it does, and its | ||
| default. |
There was a problem hiding this comment.
This page claims to index every environment variable Medulla reads, but it omits the operator-facing OPENHUMAN_WORKSPACE, OPENHUMAN_ACTION_DIR, OPENHUMAN_MEDULLA_BASE_URL, BACKEND_URL, and VITE_BACKEND_URL overrides read in src/sdk/src/core_host/mod.rs. Those bindings deliberately preserve existing values, so an exported variable can redirect state or authentication even when MEDULLA_HOME and MEDULLA_API_URL are set as documented; omitting them makes endpoint mismatches and state written outside the expected home particularly difficult to diagnose.
Useful? React with 👍 / 👎.
1 participant
Audit and editorial pass over the whole documentation set, plus a restructure so the README is the marketing landing page and the gitbook carries the depth with developer material in its own section.
What changed
README is marketing-first. The orchestrator argument moves up under the fold, the five feature paragraphs lose their bold inline headers, and the OpenRouter harness-preset paragraph (which was sitting under a heading called "Documentation") moves into the gitbook where it belongs. Install instructions, quick start, and the offline demo stay.
Editorial pass over
README.md,DEVELOPING.md, all ofdocs/, and all ofgitbooks/. The tells were clustered:Term — glosson nearly every list item and as the default mid-sentence connector.- **Thing.** description) throughout, including a six-item one intoken-efficiency.mdand ten ine2e-live-harness.md.vendoring.mdargued with its own previous revision ("This section used to say the opposite... That is now inverted"),workflows.mdnarrated what releases 0.7 and 0.8 wrote to disk, andconfiguration.mdandauthentication.mdcarried blockquotes about removed features in the middle of reference prose. These now describe the current system, with genuine upgrade notes under their own headings.Gitbook restructure. The developer section grew from 8 pages to 17. Nine new pages carry over technical material that was only in
docs/and invisible to readers: glossary, harness integration, host-link protocol, attribution and routing, troubleshooting, testing, the Rust SDK, an environment-variable index, and vendoring. The two thin overview pages (13 and 15 lines, largely restating each other) were split sowhy-an-orchestrator-model.mdmakes the argument andrlm-context-scaling.mdexplains the mechanism.Bugs found along the way
contributing.mddocumented the coverage gate as 90%; CI enforces 80.contributing.mdreferencedmock_core.rs, which does not exist. Replaced with the real contents ofsrc/sdk/tests/support/.TABSconstant, along with the nav paths that implied ("Routing > Add Host" is actually "Hosts > Add Host").workers-and-sessions.mdlisted a duplicated verb ("resume one, resume one").vendoring.mddescribed three top-level submodules that no longer exist; there is one,vendor/openhuman.architecture.mdpointed atworkflows/ops.rs, which is a directory.RUST_LOGorEnvFilteranywhere insrc/, so the new troubleshooting page documents the logging surface that actually exists rather than the one you would assume.Validation
Documentation only; no source files touched, and CI has no docs gate.
Verified mechanically across all 39 changed files: zero em/en dashes, zero curly quotes, zero emoji, no AI-vocabulary hits. Every relative link in
gitbooks/resolves,SUMMARY.mdis consistent in both directions (every page listed, every entry exists), and no file lost more than 7% of its lines. The three largest deletions were read line by line to confirm the shrinkage was rewording rather than dropped commands, flags, table rows, or code blocks.