🏗️ Framework
Comprehensive architectural framework and development guidelines
On this page
Ontology & Core Roles
The fundamental component types that form the building blocks of any PeerMesh platform.
Module
Headless capability that owns contracts, exposes APIs/events, and optionally manages data domains
Characteristics:
Examples:
Plugin
App-wide feature that introduces routes/flows, composes Modules, and hosts Widgets
Characteristics:
Examples:
Widget
User-configurable, page-level component mounted in named slots
Characteristics:
Examples:
Foundation & Core
Basic framework elements
Process & Standards
Development processes and standards
Advanced & Governance
Advanced features and governance
Tenant and Environment Policy
Policies for multi-tenant deployments and environments
Interoperability Surfaces
The standardized interfaces through which PeerMesh components communicate and integrate.
UI
User interface integration points
Elements:
API
Application programming interfaces
Elements:
Events
Event-driven communication
Elements:
Data
Data layer integration
Elements:
Identity
Identity and authentication
Elements:
Policy
Security and governance
Elements:
Federation
Cross-platform communication
Elements:
Operations
Operational concerns
Elements:
Design Guidelines
Core principles and rules that guide component development and ensure architectural consistency.
Granularity Heuristics
Write contracts as business verbs (e.g., `asset.mint`) not low-level operations
Keep families coherent (5–10 verbs). Split by lifecycle and trust boundary
Use flags to express optional features (don't fork contracts)
Guardrails
Widgets never talk to externals directly
Identity linkages always traverse the Identity Graph
Data enters via the Data Layer; avoid side channels
Prefer Events for cross-component communication
Rules of Thumb
If it renders routes → Plugin
If it's user-placeable UI → Widget
If it's headless/shared infrastructure → Module
If it touches an external thing → add an Integration attribute to whichever roles apply