Skip to content

docs: sync architecture with current firmware - #190

Open
tzhengus wants to merge 1 commit into
memovai:mainfrom
tzhengus:codex/sync-architecture-docs
Open

docs: sync architecture with current firmware#190
tzhengus wants to merge 1 commit into
memovai:mainfrom
tzhengus:codex/sync-architecture-docs

Conversation

@tzhengus

@tzhengus tzhengus commented Jul 4, 2026

Copy link
Copy Markdown

Summary

Update docs/ARCHITECTURE.md so it reflects the current firmware instead of older implementation assumptions.

Changes

  • Document Telegram, Feishu/Lark, WebSocket, and system dispatch paths.
  • Replace build-time-only configuration notes with build-time defaults plus NVS runtime overrides.
  • Update LLM provider docs for Anthropic and OpenAI.
  • Update web search docs for Tavily-preferred search with Brave fallback.
  • Document current tools: search, time, SPIFFS files, cron, and GPIO.
  • Add current startup services: skills, cron, heartbeat, Feishu, and WiFi onboarding/admin portal.
  • Refresh the Nanobot reference mapping for implemented and still-missing pieces.

Validation

  • git diff --check

Summary by CodeRabbit

  • Documentation
    • Reworked the architecture guide to reflect the latest system design and startup flow.
    • Updated the component map, task layout, flash usage, and configuration model.
    • Expanded the communication and tool-handling overview, including supported AI provider formats and safer file-path handling.
    • Refreshed the serial command reference and state/storage descriptions.

@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7d9f331a-0926-41a4-81af-a539df283530

📥 Commits

Reviewing files that changed from the base of the PR and between bb10ea0 and dd47574.

📒 Files selected for processing (1)
  • docs/ARCHITECTURE.md

📝 Walkthrough

Walkthrough

This PR substantially rewrites docs/ARCHITECTURE.md to describe a consolidated ESP32-S3 MimiClaw architecture: a FreeRTOS queue-based agent loop calling an LLM via HTTPS proxy, updated module map, config model, message bus struct, tool registry, LLM providers, startup sequence, and CLI commands. No code changes.

Changes

Architecture Documentation Rewrite

Layer / File(s) Summary
System overview and data flow
docs/ARCHITECTURE.md
New text-based flow diagram, SPIFFS persistent state inventory, and step-by-step queue/agent-loop data flow description.
Module map, tasks, and flash layout
docs/ARCHITECTURE.md
Updated module/directory breakdown, FreeRTOS task table with priorities/stack sizes, and revised flash partition layout.
Configuration and message bus
docs/ARCHITECTURE.md
Two-layer build-time/NVS runtime config model, updated build-time secret defines, and revised mimi_msg_t message bus struct/queue description.
Tools and LLM providers
docs/ARCHITECTURE.md
Expanded tool registry with /spiffs/ path restriction and traversal rejection, plus Anthropic and OpenAI provider request format documentation.
Startup sequence, CLI, and reference mapping
docs/ARCHITECTURE.md
Rewritten init/start order, updated serial CLI command set, and revised Nanobot-to-MimiClaw mapping table.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly reflects the main change: updating architecture docs to match the current firmware.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant