Modulo Documentation

This is the documentation hub for Modulo. Topic-specific guides live in the themed folders below; component-local docs (backend, smart contracts, infra) are linked from the Component & infrastructure docs section at the bottom.

New here? Start with the root README for the project overview, quick start, and architecture summary.

Roadmap

• Feature ideas & roadmap

Architecture

• B2 — Core/Experience boundary audit
• ADR 0001 — Encryption key derivation
• ADR 0002 — Core keeps first-class note/link/tag/user types
• Knowledge graph milestone

Plugins

• Plugin system architecture & API design
• Plugin development guide
• Plugin system summary
• Plugin manager UI
• Plugin marketplace UI
• Plugin submission system
• Third-party plugin hosting
• gRPC plugin service
• Frontend plugin module: frontend/src/features/plugins/README.md

Blueprint system

• Visual editor
• Interpreter
• Node catalog

Mobile

• Mobile OAuth & blockchain authentication
• Mobile responsiveness
• Mobile performance testing & debugging

Sync & offline storage

• Conflict resolution for simultaneous edits
• Network reconnection & auto-sync
• SQLite offline storage

Attachments & storage

• Azure Blob Storage for attachments

Authentication & authorization

• Frontend PKCE login flow
• Role/claim matrix & least-privilege defaults
• Custom role migration guide
• OAuth migration documentation
• Role implementation examples
• Admin & operator playbook
• Smoke-test checklist
• Role matrix documentation tests

Security

• Encrypted note sharing — security model
• Security testing & cloud deployment hardening
• Security testing guide
• Security findings remediation
• Vulnerability remediation playbook
• CodeQL code scanning
• OWASP ZAP scanning
• Secret scanning & pre-commit hooks
• Container image signing with Cosign
• Repo-wide security policy

Secrets management

• Local development secrets (SOPS + direnv)
• External Secrets Operator

Observability & operations

• OpenTelemetry implementation
• Audit logging & decision tracing
• Health endpoints & Kubernetes probes
• Service Level Objectives (SLOs)
• Database backup & restore

Performance

• Performance testing
• AuthN/Z performance & resilience benchmark
• API response time optimization
• Mobile performance testing

Deployment

• Kubernetes deployment

CI, policy & release process

• Policy CI gate
• Policy directory
• Conventional commits guide
• Release workflow test

Component & infrastructure docs

These live next to the code they describe:

• Backend: Blockchain integration · IPFS integration · Config validation · JaCoCo coverage guide
• Smart contracts: README · Deployment · Polygon mainnet deployment · Security audit report
• Azure: Setup overview · Application Insights setup
• Kubernetes / infra: see the README.md in each k8s/ subfolder (observability, chaos-engineering, incident-response, cost-management, …)
• Load testing: k6-tests/