docs: add mermaid architecture documentation - #148
Draft
svngoku wants to merge 1 commit into
Draft
Conversation
- docs/ARCHITECTURE.md: system components, turn loop, recursion tree, session layout - docs/CONCEPTS.md: minimal tool interface, persistent kernel, compaction, recursion, skills, git guard - docs/USER_FLOW.md: CLI entry modes, headless run, stop reasons, recursion, ACP lifecycle - docs/CONFIGURATION.md: full RLM_* reference, provider resolution, tooling presets - AGENTS.md: pointer to docs/ Grounded in the official deepwiki docs and verified against src/rlm/.
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
Adds a
docs/knowledge base with Mermaid diagrams (rendered natively on GitHub), grounded in the source undersrc/rlm/:docs/ARCHITECTURE.md— system component graph, the act–observe turn loop, recursion tree (broker/supervisor), on-disk session layoutdocs/CONCEPTS.md— minimal tool interface, persistent kernel state, context compaction, native recursion (await rlm()), skills system, git-history guarddocs/USER_FLOW.md— CLI entry modes, headless run, stop reasons, recursion flow, ACP session lifecycledocs/CONFIGURATION.md— fullRLM_*env-var reference with defaults, provider resolution order, tooling presets (dual/tools/skills), config model diagramAGENTS.md— pointer todocs/Notes
markdownlint-cli2passes (0 issues).docs/CONFIGURATION.mddocuments the current source behavior, which fixes two stale README claims without touching the README itself:RLM_MAX_OUTPUT/RLM_MAX_TOOL_OUTPUT_CHARSwere removed in d4ce3e1, and the defaultdualpreset enables thebash/editskills.