🏗️ 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.
In this framework draft, a Plugin is a role inside the platform. Add-ons that other people write are called extensions.
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
Ontology & Typology
Core roles, configuration layer, and integration facets
Intake Template - IDEA
Standardized template for capturing new component ideas
Capability Families
Groupings of related capabilities and contracts
Provider Cards
Standardized provider information and comparison format
Capability Matrix
Matrix showing capability coverage across providers
Resolver Policy
Policies for resolving capability requests to providers
Conformance Kit
Testing and validation tools for component conformance
Surfaces Glossary
Definitions of all interop surfaces and integration points
Process & Standards
Development processes and standards
Workflow Playbook
Standard workflows for component development and integration
Prompts for Agents
AI agent prompts for automated component tasks
Document Conventions
Standards for documentation format and structure
Flags Registry
Registry of all capability flags and their meanings
Error Taxonomy
Standardized error codes and handling patterns
Canonical Receipt
Standard format for transaction and operation receipts
Advanced & Governance
Advanced features and governance
Source of Truth Registry
Registry defining authoritative data sources
Event Envelope and Naming
Standards for event structure and naming conventions
Route and Slot Conventions
Conventions for UI routing and widget slot naming
Permissions Registry
Registry of all permissions and access control patterns
Provider Scorecard
Standardized scoring system for provider evaluation
Stage Gates (AF/SM)
Quality gates based on Artifact Fidelity and Solution Maturity
Data Export Packaging
Standards for data export formats and packaging
Tenant and Environment Policy
Policies for multi-tenant deployments and environments
Governance and Change Control
Framework governance and change management processes
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