docs(openhuman): add per-module READMEs for domain modules#2992
Merged
senamakel merged 1 commit intoMay 29, 2026
Conversation
Add detailed README.md to 74 high-level modules under src/openhuman/ that lacked one. Each README documents the module's responsibilities, key files, public surface, RPC controllers, agent tools, events, persistence, and real dependencies traced from `use crate::openhuman::` imports. Pre-existing curated READMEs (agent, channels, config, cron, encryption, security, skills, app_state, accessibility, memory_*) are left untouched.
Contributor
|
Caution Review failedPull request was closed or merged during review 📝 WalkthroughWalkthroughThis PR adds comprehensive README documentation for 99 OpenHuman modules, covering infrastructure services, agent systems, integrations, memory persistence, user-facing features, request pipelines, authentication, specialized domains, inference capabilities, and UI bridges. No code logic is modified; all changes are documentation files describing module responsibilities, RPC surfaces, persistence models, dependencies, and behavioral notes. ChangesModule Documentation Coverage
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
|
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
README.mdto 74 high-level domain modules undersrc/openhuman/that previously had none.use crate::openhuman::/use crate::core::imports).agent,channels,config,cron,encryption,security,skills,app_state,accessibility, and thememory_*family) are left untouched.Problem
src/openhuman/tree has ~90 domain modules but only ~19 had a README, making it hard for contributors (and agents) to understand a module's purpose, surface, and dependencies without reading all its source.Solution
local_mascotswas skipped because its directory is empty (no source to document).Submission Checklist
Impact
Related
AI Authored PR Metadata (required for Codex/Linear PRs)
Linear Issue
Commit & Branch
Validation Run
cargo checkran clean; no Rust changed)Validation Blocked
command:N/Aerror:N/Aimpact:N/ABehavior Changes
Parity Contract
Duplicate / Superseded PR Handling
Summary by CodeRabbit
Release Notes