reticulum-ref/MeshChatX
1
0
Fork 0
mirror of https://github.com/Quad4-Software/MeshChatX.git synced 2026-08-18 09:49:09 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
MeshChatX/docs/agents
History
Ivan d23b169b41
feat(android): integrate BLE and USB support with Chaquopy, improving RNode functionality
2026-07-10 11:39:19 -05:00
..
conventions docs(agents): add agent conventions and skills documentation 2026-07-10 00:57:48 -05:00
skills feat(android): integrate BLE and USB support with Chaquopy, improving RNode functionality 2026-07-10 11:39:19 -05:00
overview.md docs(agents): add agent conventions and skills documentation 2026-07-10 00:57:48 -05:00
README.md docs(agents): add agent conventions and skills documentation 2026-07-10 00:57:48 -05:00

README.md

Agent guidance for MeshChatX

Neutral, tool-agnostic notes for automated agents and human contributors who work like agents. This tree is not part of the in-app user documentation. End-user docs live under docs/en/.

Start here

  1. Read overview.md for architecture, storage, security, env vars, and invariants.
  2. Read conventions/reticulum-zen.md before any mesh-facing design or code.
  3. Apply conventions/ for the surface you are editing.
  4. Open a skills/ guide when the task matches that workflow.

Root AGENTS.md is a short pointer to this directory. Cursor rules under .cursor/rules/:

  • Always on: meshchatx-core.mdc, reticulum-zen-gates.mdc
  • Globs: meshchatx-backend.mdc, meshchatx-frontend.mdc, meshchatx-android.mdc, meshchatx-tests.mdc

Layout

Path Purpose
overview.md Project brief and critical invariants
conventions/reticulum-zen.md Zen of Reticulum hard gates
conventions/core.md Always-on standards
conventions/frontend.md Vue UI
conventions/backend.md Python / HTTP / SQLite
conventions/android.md Android WebView bridge
conventions/tests.md Test placement and verification

Skills

UI and wiring

Skill Use when
page-toast-tests New pages, toasts, i18n, tests
contribution-registries Nav, tools, commands, settings search, WS event wiring

Identity and data

Skill Use when
identity-restore Identity key vs database zip restore
identity-switch-teardown Live identity switch without cross-identity leaks
database-migrations-backups Schema bumps, backups, snapshots, restore safety
landlock-sqlite Landlock + SQLite conversation failures

Security and plugins

Skill Use when
reticulum-design-gates Mesh design review against Zen of Reticulum
auth-csrf-ws-security CSRF, auth, WS mutator denylist
plugin-install-security Plugin install, RSG, permissions, integrity
rns-link-api Generic RNS Link WebSocket / plugin transport

Platforms and boot

Skill Use when
deferred-network-startup HTTP-up vs RNS-ready, status, 503s, RNS panic
electron-frozen-packaging Frozen desktop spawn, loading, crash recovery
android-webview-bridge Android chooser MIME, storage, WebView navigation

Verification

Skill Use when
test-loop Focused verification without hung shells

Product docs (users)

  • docs/en/architecture.md
  • docs/en/identity-and-security.md
  • docs/en/getting-started.md
  • docs/en/rns-link-api.md
  • docs/en/platform-guides/linux-sandbox.md
  • CONTRIBUTING.md