docs(readme): mermaid architecture diagram, cross-platform commands, ground-truth fixes#144
Conversation
…ground-truth fixes
- Redraw the ASCII architecture sketch as a Mermaid flowchart (renders on
GitHub; parses clean as flowchart-v2): two front-ends (workbench + #MB-Web)
over the three same-origin backends (/v1 proxy-or-direct, /agent ADK+MiniMax,
/web mineru+translate).
- Make commands platform-neutral: examples now use plain `npm` (macOS/Linux)
with a shell-convention note that Windows PowerShell uses `npm.cmd`; the
Codex-sandbox fallback shows both `/` and `\` path forms. Drop `powershell`
code fences for `sh`.
- Correct doc drift against the current tree: /web/* is mineru convert + LLM
translate (not "currently mineru"); plugins live in server/*/vitePlugin.ts and
are registered in vite.config.ts; sidecar spans server/{agent,web,shared};
expand Project layout to the real src/ + server/ dirs (mb, config, hooks,
state, telemetry, web, shared); add check:bundle + smoke:core command rows;
fix the Commands nav anchor.
Docs-only; no behavior change, no version bump.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthrough
ChangesREADME Documentation Refresh
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
What
README polish, driven by three asks:
flowchart LR(validated: parses asflowchart-v2, renders natively on GitHub). Shows the two front-ends (workbench#chat/#base/#graph…+ the#MB-Web论文知识库) over the three same-origin backends:/v1/*(Vite proxy on the default URL, direct fetch on a custom one),/agent/*(Google ADK + MiniMaxLlm, with core tools + optional Tavily/Jina), and/web/*(mineru convert + LLM translate).npm(macOS/Linux) with a shell-convention note that Windows PowerShell usesnpm.cmd; the Codex-sandbox fallback shows both/and\path forms.powershellfences →sh. Commands heading + nav anchor updated (#commands)./web/*is described as mineru convert + LLM translate (was "currently mineru conversion").server/*/vitePlugin.tsand registered invite.config.ts(was "Both live in vite.config.ts"); sidecar now spansserver/{agent,web,shared}.src/{mb,config,hooks,state,telemetry}andserver/{web,shared}, pluscomponents/BilingualView.check:bundleandsmoke:corerows to the commands table.knowledge).Verification
mermaidunder jsdom →PARSE OK (flowchart-v2)..prettierignore), soformat:checkis unaffected; CI's code gates don't touch README content.🤖 Generated with Claude Code
Summary by CodeRabbit