Skip to content

docs(readme): mermaid architecture diagram, cross-platform commands, ground-truth fixes#144

Merged
helebest merged 1 commit into
mainfrom
worktree-readme-polish
Jun 29, 2026
Merged

docs(readme): mermaid architecture diagram, cross-platform commands, ground-truth fixes#144
helebest merged 1 commit into
mainfrom
worktree-readme-polish

Conversation

@helebest

@helebest helebest commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

What

README polish, driven by three asks:

  1. Architecture diagram → Mermaid. Replaces the ASCII sketch with a flowchart LR (validated: parses as flowchart-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).
  2. Commands are no longer Windows-only. 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. powershell fences → sh. Commands heading + nav anchor updated (#commands).
  3. Ground-truth corrections against the current tree:
    • /web/* is described as mineru convert + LLM translate (was "currently mineru conversion").
    • Sidecar plugins: noted as defined in server/*/vitePlugin.ts and registered in vite.config.ts (was "Both live in vite.config.ts"); sidecar now spans server/{agent,web,shared}.
    • Project layout expanded to the real dirs: src/{mb,config,hooks,state,telemetry} and server/{web,shared}, plus components/BilingualView.
    • Added check:bundle and smoke:core rows to the commands table.
    • Markdown reader wording: "source- and knowledge-layer" (the K-layer wire value is knowledge).

Verification

  • Mermaid block parsed with the project's installed mermaid under jsdom → PARSE OK (flowchart-v2).
  • Docs-only: no behavior change, no version bump, no CHANGELOG entry. Markdown is excluded from Prettier (.prettierignore), so format:check is unaffected; CI's code gates don't touch README content.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated setup and command examples for cross-platform use, including clearer PowerShell and POSIX-style instructions.
    • Refreshed the architecture diagram with a Mermaid flowchart and clarified how web requests are handled.
    • Improved the markdown viewer description to better reflect bilingual dual-column rendering.
    • Updated deployment steps and project layout details to match the current folder structure.

…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>
@coderabbitai

coderabbitai Bot commented Jun 29, 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 Plus

Run ID: 45bea3ee-0423-44a1-b2d4-7dc39acd4a5c

📥 Commits

Reviewing files that changed from the base of the PR and between b2df975 and f2b89ce.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md is updated to replace Windows PowerShell-specific commands with cross-platform npm examples, swap the ASCII architecture diagram for a Mermaid flowchart, revise the MarkdownView.tsx description, switch deployment commands to POSIX style, and expand the project layout directory tree with new folders.

Changes

README Documentation Refresh

Layer / File(s) Summary
Cross-platform commands, architecture diagram, component descriptions, deployment, and project layout
README.md
Navigation anchor updated to #commands; PowerShell-specific command block replaced with cross-platform npm examples including a PowerShell npm.cmd note; ASCII architecture diagram replaced with a Mermaid flowchart with updated /web/* semantics; MarkdownView.tsx description updated to reference source- and knowledge-layer rendering; deployment commands switched from npm.cmd to POSIX npm run build/npm start; project layout tree expanded with mb/, config/, hooks/, state/, telemetry/ and detailed server/ subdirectory roles.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • OpenDIKW/dikw-web#33: Also modifies README command/build-and-deployment documentation around npm/npm.cmd usage.
  • OpenDIKW/dikw-web#104: Also modifies README's "Markdown reader" section describing how MarkdownView.tsx handles markdown content.

Poem

🐇 Hopping cross platforms, no PowerShell fear,
Mermaid diagrams bloom where ASCII was near,
New folders emerge in the layout so bright,
npm start and npm run build — all POSIX, just right.
The docs hop along, updated today,
This rabbit approves in the most cheerful way! 🌸

🚥 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 accurately summarizes the README documentation updates, including the Mermaid diagram, cross-platform commands, and content corrections.
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
  • Commit unit tests in branch worktree-readme-polish

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.

@helebest helebest merged commit e08d20b into main Jun 29, 2026
10 checks passed
@helebest helebest deleted the worktree-readme-polish branch June 29, 2026 23:11
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