Files
mnote/REASONIX.md
T

5.3 KiB

MNOTE — Reasonix working knowledge

Stack

  • Rust — workspace of 11 crates, edition 2021, resolver 2, wasm32 target (rust/rust-toolchain.toml)
  • Axum 0.8 — HTTP/WebSocket server in mnote-web crate
  • Leptos 0.8.14 — SSR island rendering in mnote-web
  • Convex 1.x — self-hosted document/real-time/storage backend (infra/convex/docker-compose.yml)
  • Playwright — browser smoke tests in scripts/task-*.js

Layout

Path Contents
rust/crates/mnote-web/ Rust web gateway (axum + Leptos SSR, :3000)
rust/crates/core-protocol/ Kernel types, projection protocol, tree/graph terms
rust/crates/bridge-runtime/ Kernel query/command, Convex transport args generation
rust/crates/mnote-cli/ CLI tool (sidebar dataset, page get/create/title/save/move, block insert/patch)
rust/crates/storage-convex-bridge/ Convex storage bridge for Rust
convex/ Convex schema (schema.ts) + functions (aiSessions.ts)
infra/convex/ Docker Compose for self-hosted Convex backend
infra/onlyoffice/ Docker Compose for OnlyOffice
scripts/ Node.js dev/build scripts + Playwright smoke tests
design/ Architecture design documents organized by domain
bugs/ Bug tracking mirroring design domain structure
recycle/ Retired code (old frontend, deprecated design drafts)

Commands

  • npm run desktop:hot — hot-reload dev start (Rust gateway + optional FastAPI backend + optional Celery)
  • npm run dev:hot — same but with cargo-watch for Rust auto-recompile
  • npm run desktop — production start
  • cargo test -p <crate> — test a specific Rust crate
  • cargo run -p mnote-web --bin mnote-web — run the web server binary directly
  • codegraph sync . — refresh CodeGraph after normal code changes
  • codegraph index . --force — rebuild CodeGraph after large refactors, ignore-rule changes, or stale index behavior

CodeGraph MCP

  • Reasonix has codegraph=codegraph serve --mcp configured in /home/lix/.reasonix/config.json.
  • Prefer CodeGraph for structural code questions: symbol lookup, definitions, callers/callees, impact analysis, and focused cross-file context.
  • Use codegraph_search for symbol names, codegraph_callers / codegraph_callees for call flow, codegraph_impact before risky edits, codegraph_context for focused task context, and codegraph_files / codegraph_status for index inspection.
  • Use native search only for literal text, comments, log messages, or after a specific file is already identified.
  • Keep the project index fresh in development: run codegraph sync . after code changes; use codegraph index . --force when the index looks stale or after broad restructuring.

Reference-Code Comparison

  • Reference implementations live under /mnt/Data1T/mnote/reference-code/; prefer /mnt/Data1T/mnote/reference-code/sidex-main for VSCode workbench comparisons because it contains the fuller src/vs/workbench tree, while reference-code/vscode is a smaller auxiliary snapshot.
  • Compare one feature slice at a time, such as explorer open target, editor tabs, resource lifecycle, drag-and-drop ordering, keybindings, or overlay placement.
  • Fast workflow: check codegraph_status for both projects, locate reference entry points with codegraph_search/context, inspect callers/callees, inspect the matching MNote chain, then map the result onto Rust kernel / mnote-web / frontend host boundaries.
  • Always classify findings as: reusable interaction/state model, reference-only implementation detail, or incompatible with MNote local-first / tree-first architecture.

Conventions

  • Smoke test pattern: standalone Playwright scripts under scripts/task-*.js using a shared harness (ensureAuthenticated, createTempDocument, cleanupDocuments). All use "use strict" and require("playwright") (scripts/task110-page-title-single-truth-smoke.js:1-4).
  • Rust workspace: edition 2021, resolver "2", MIT license. All crates inherit workspace version (rust/Cargo.toml:2-8).
  • Convex boundary: root convex/ is the active deploy source for ACP / Hermes runtime state (schema.ts + aiSessions.ts). Do not deploy from recycle/wolai-frontend/convex; old documents / mediaAssets / users / workspaces functions must be explicitly migrated to active code, moved to an auxiliary area, or retired.
  • Bug tracking: bugs organized by design domain directory (e.g. bugs/04-tree-domain/process/), moved to done/ when fixed (bugs/README.md).
  • Design docs: organized by domain in design/, with process/ (in-progress) and done/ (completed) subdirs (design/README.md).

Watch out for

  • write_file path rule: paths are sandbox-relative; leading / is stripped. Use path: "design/..." not /mnt/Data1T/mnote/design/....
  • .aionrs/, .claw/, .codex/, .gemini/ — session data from other AI tools, not project code. Don't read or edit.
  • recycle/ — retired code, not current implementation. Don't use as evidence for current behavior.
  • Convex must be running (infra/convex/) for full-stack dev — smoke tests depend on a live Convex backend.
  • Rust wasm32 target required (rust/rust-toolchain.toml), needed for tree-shell-runtime-wasm crate.
  • rust/target/ is gitignored and large — cargo build runs from scratch if cache is missing.