Knowledge Portal · engineering documentation

Skip to content

ZAIXOS Engineering Index

Engineering Operating System v1.0 · Engineering Runtime Platform v1.0 (Phase 11-2A)
Runtime baseline: v5.2-local-development-runtime (Consumer #1 local development)
Product platform baseline: v4.2-public-experience-platform
Target freeze tag (EOS): v5.0-ai-development-environmentrelease doc
Target freeze tag (ERP): v5.1-engineering-runtime-platform (provisional)

Consumer #1 frozen engineering layers (Dental Clinic ROS)

LayerTagDoc
Environment & Configurationv5.2-local-development-runtimeConsumer docs/development/FROZEN_ENGINEERING_LAYERS.md
Local DNS Platformv5.2-local-development-runtimeConsumer docs/development/LOCAL_DEVELOPMENT_RUNTIME.md
Local Development Runtimev5.2-local-development-runtimev5.2-local-development-runtime.md

Lifecycle: Standalone platform repository @ Platform GA v1.0.0 — Consumer #1 (Dental Clinic ROS) integrated via Composer + .zaixos/ lock (phase-12-9-platform-ga-report.md). Terminology EOS / ERP is transitional; forward platform name is ZEP (PLATFORM_INDEX.md).
Onboarding: ERP_DEVELOPER_GUIDE.md — start here for engineering workflow. This index is the asset map, not the entry point.

Root authority: AI_DEVELOPMENT_ENVIRONMENT.md
Platform authority: PLATFORM_INDEX.md
EOS design authority: phase-10-ai-development-environment-specification.md
ERP Core authority: phase-11-engineering-runtime-platform-specification.md


1. Governance (read first)

Authority chain (conflict resolution)

PriorityPathKey documents
1docs/releases/Frozen baselines
2docs/architecture/PROJECT_CONSTITUTION.md, MODULE_BOUNDARIES.md, LONG_TERM_ROADMAP.md
3docs/development/AI_DEVELOPMENT_ENVIRONMENT.md, ENGINEERING_INDEX.md, Phase 10 spec, Phase 11 ERP spec
4docs/company/ + docs/product/COMPANY_CONSTITUTION.md, PRODUCT_VISION_AND_STRATEGY.md
5knowledge/Operational patterns, playbooks, recipes

EOS operational documents

DocumentRole
AI_DEVELOPMENT_ENVIRONMENT.mdEOS methodology root
phase-10-ai-development-environment-specification.mdEOS design authority
phase-10-ai-development-environment-discovery.mdEOS discovery input
phase-11-engineering-runtime-platform-specification.mdERP Core design authority
phase-11-engineering-runtime-contracts.mdRuntime contract obligations
phase-11-4-runtime-procedures-workflows-specification.mdRuntime Procedures & Workflows architecture
adapters/cursor-adapter-v1-profile.mdRuntime Adapter v1 profile (Cursor)
erp-freeze-preparation.mdERP v1.0 validation & freeze readiness (Phase 11-9)
ERP_DEVELOPER_GUIDE.mdDeveloper onboarding — start here for ERP usage
ERP_ACCEPTANCE_CHECKLIST.mdERP acceptance gate (Phase 11-10)
ERP_RUNTIME_VALIDATION.mdManual runtime layer validation
DEVELOPMENT_WORKFLOW.mdOperational lifecycle
RESPONSE_TEMPLATE.mdArchitect review (9 sections — ERP v1.0)
GIT_FREEZE_PROCEDURE.mdDeveloper Git freeze
WORKSPACE_MANAGEMENT.mdZAIXOS multi-root workspace procedure
v5.0-ai-development-environment.mdEOS v1.0 freeze release (provisional tag)

ERP reports (Runtime Implementation)

Two formats only — templates/implementation-report.md:

FormatSectionsWhen
Implementation phaseArchitecture Summary, Files Changed, Tests, Remaining RisksCode/runtime passes
Documentation phaseSummary, Files Created, Files Modified, Verification, Remaining Gaps, DecisionDocumentation-only passes

2. ERP Core

Authority: phase-11-engineering-runtime-platform-specification.md

IDE-agnostic runtime abstraction. ERP Core defines abstract components — not vendor file formats.

ERP componentCanonical manifest / policyCount
Runtime ConstraintsEOS rule categories + rules catalog (adapter mirror) · RuntimeConstraintContract9 enforcement + 11 reference catalogs
Runtime Proceduresskills-manifest.md · RuntimeProcedureContract10
Runtime Workflowscommands-catalog.md · RuntimeWorkflowContract10
Runtime Delegationagents-manifest.md · RuntimeDelegationContract10
Runtime Enforcementenforcement-manifest.md · RuntimeEnforcementContractMinimum event set (4)
Runtime Context Providerscontext-providers-manifest.md · RuntimeContextProviderContractImmediate tier (3) — disabled
Runtime Executionexecution-manifest.md · RuntimeExecutionContract4 modes (Local · CLI · Cloud · Background)
Runtime Adaptersdocs/development/adapters/*-profile.mdSee §3

Layer model: Documentation Authority → ERP Core → Runtime Adapter → Native IDE Runtime → Human Authority.


3. Runtime Adapters

Every IDE implements ERP Core through a Runtime Adapter profile. Vendor paths and formats live in adapter profiles only — not in ERP Core.

AdapterStatusProfile
Adapter v1 (Cursor)First implementation targetcursor-adapter-v1-profile.md
Claude AdapterFutureTBD
OpenAI IDE AdapterFutureTBD
VS Code AI AdapterFutureTBD
Windsurf AdapterFutureTBD

Adapter v1 workspace (Cursor)

Native mirror paths — see cursor-adapter-v1-profile.md for full mapping.

ERP componentAdapter v1 path
Runtime Constraints.cursor/rules/*.mdc
Runtime Procedures.cursor/skills/*/SKILL.md
Runtime Workflows.cursor/skills/{workflow}/SKILL.md
Runtime Delegation.cursor/agents/*.md
Runtime Enforcement.cursor/hooks.json
Runtime Context Providers.cursor/mcp.json
Runtime Execution (local)Committed .cursor/ workspace
Runtime Execution (CLI).cursor/cli.json
Runtime Execution (cloud).cursor/environment.json
Runtime Execution (background)Inherits parent session .cursor/

See §14 Version control policy.


4. Manifests (docs/development/)

ManifestPathCanonical for
Runtime Procedure Manifestskills-manifest.mdDomain procedure inventory · RuntimeProcedureContract
Runtime Delegation Manifestagents-manifest.mdDelegation role inventory · RuntimeDelegationContract
Runtime Workflow Manifestcommands-catalog.mdWorkflow inventory · RuntimeWorkflowContract
Runtime Enforcement Manifestenforcement-manifest.mdHook inventory · RuntimeEnforcementContract
Runtime Context Provider Manifestcontext-providers-manifest.mdProvider inventory · RuntimeContextProviderContract
Runtime Execution Manifestexecution-manifest.mdExecution mode inventory · RuntimeExecutionContract
ERP freeze preparationerp-freeze-preparation.mdValidation summary · freeze readiness (11-9)
ERP developer guideERP_DEVELOPER_GUIDE.mdOnboarding · official workflow · daily examples
ERP acceptance checklistERP_ACCEPTANCE_CHECKLIST.mdDX acceptance gate (11-10)
ERP runtime validationERP_RUNTIME_VALIDATION.mdManual runtime validation procedures
Context provider policymcp-governance.mdPointer → adapter governance
Context provider registry summarymcp-registry.mdPointer → canonical manifest

5. Runtime Constraints catalog

CategoryCatalog.mdc rule
EOS authority00-eos-authority.mdcalwaysApply
Freezecatalog/freeze.md10-freeze-boundary.mdc
Architecturecatalog/architecture.md20-architecture-patterns.mdc
DDDcatalog/ddd.mdextends B
Implementationcatalog/implementation.md30-implementation.mdc
Review / scopecatalog/review.md40-phase-scope.mdc
Documentationcatalog/documentation.md50-documentation.mdc
AIcatalog/ai.md60-ai-alignment.mdc
Git / toolingcatalog/git.md70-tooling-safety.mdc
UIcatalog/ui.mdshared with B
Testingcatalog/testing.mdshared with C
Releasecatalog/release.mdshared with E/G
Repository90-repo-specific.mdcalwaysApply

Precedence: A > B > D > C > F > E > G — rules/catalog/README.md


6. Runtime Procedures (10)

Contract: RuntimeProcedureContract · phase-11-engineering-runtime-contracts.md §5
Specification: phase-11-4-runtime-procedures-workflows-specification.md §6
Canonical inventory: skills-manifest.md
Adapter mapping: cursor-adapter-v1-profile.md · .cursor/skills/{domain}/SKILL.md
Status: Phase 11-4A — implemented in Cursor Adapter v1

Manifest IDDomainTierAdapter path
skill-architectureArchitectureCore.cursor/skills/architecture/SKILL.md
skill-platformPlatformCore.cursor/skills/platform/SKILL.md
skill-laravelLaravelImplementation.cursor/skills/laravel/SKILL.md
skill-dddDDDImplementation.cursor/skills/ddd/SKILL.md
skill-testingTestingCore.cursor/skills/testing/SKILL.md
skill-documentationDocumentationCore.cursor/skills/documentation/SKILL.md
skill-ui-uxUI/UXImplementation.cursor/skills/ui-ux/SKILL.md
skill-ai-experienceAI ExperienceSpecialist.cursor/skills/ai-experience/SKILL.md
skill-securitySecuritySpecialist.cursor/skills/security/SKILL.md
skill-devopsDevOpsSpecialist.cursor/skills/devops/SKILL.md

Each procedure includes Purpose, Inputs, Outputs, Responsibilities, Forbidden Actions, Dependencies, and cites RuntimeProcedureContract. Auto-invocation permitted via skill description metadata.


7. Runtime Delegation (10)

Contract: RuntimeDelegationContract · phase-11-engineering-runtime-contracts.md §7
Canonical inventory: agents-manifest.md
Adapter mapping: cursor-adapter-v1-profile.md · .cursor/agents/{role}-agent.md
Status: Phase 11-5 — implemented in Cursor Adapter v1

Delegate IDRoleOwnerReadonlyAdapter path
delegate-architectureArchitectureDeveloper launches; Architect consumesYes.cursor/agents/architecture-agent.md
delegate-implementationImplementationDeveloper via Phase ImplementationNo.cursor/agents/implementation-agent.md
delegate-testingTestingDeveloper (parallel)No.cursor/agents/testing-agent.md
delegate-documentationDocumentationDeveloper for documentation phasesNo.cursor/agents/documentation-agent.md
delegate-uiUIDeveloper for UI sub-phasesNo.cursor/agents/ui-agent.md
delegate-ai-experienceAI ExperienceDeveloper for AI host phasesNo.cursor/agents/ai-experience-agent.md
delegate-securitySecurityDeveloper before review (optional)Yes.cursor/agents/security-agent.md
delegate-boundaryBoundaryDeveloper before Architect reviewYes.cursor/agents/boundary-agent.md
delegate-reviewReviewDeveloper via Review Preparation (optional)Yes.cursor/agents/review-agent.md
delegate-releaseReleaseDeveloper during freeze preparationNo.cursor/agents/release-agent.md

Each delegate cites RuntimeDelegationContract, includes valid YAML frontmatter, and enforces escalation Runtime Delegation → Developer → Architect (RESPONSE_TEMPLATE.md). No direct delegation–Architect channel.

Readonly delegates: Architecture, Security, Boundary, Review — readonly: true in frontmatter.


7A. Runtime Enforcement

Contract: RuntimeEnforcementContract · phase-11-engineering-runtime-contracts.md §8
Canonical inventory: enforcement-manifest.md
Configuration: .cursor/hooks.json · schema version 1
Adapter mapping: cursor-adapter-v1-profile.md
Status: Phase 11-6 — implemented in Cursor Adapter v1

Enforcement IDERP categoryNative eventHandlerfailClosed
enforcement-shell-guardShell executionbeforeShellExecutionshell_guard.pyYes
enforcement-mcp-guardContext provider executionbeforeMCPExecutionmcp_guard.pyYes
enforcement-delegation-guardDelegation startsubagentStartdelegation_guard.pyYes
enforcement-prompt-guardPrompt submit (optional)beforeSubmitPromptprompt_guard.pyNo

Execution order: shell → MCP → delegation → prompt. Critical handlers fail-closed on error. Runtime Constraints remain authoritative — enforcement implements deterministic guards only.


8. Runtime Workflows (10)

Contract: RuntimeWorkflowContract · phase-11-engineering-runtime-contracts.md §6
Specification: phase-11-4-runtime-procedures-workflows-specification.md §7
Canonical inventory: commands-catalog.md
Adapter mapping: cursor-adapter-v1-profile.md · .cursor/skills/{catalog-id}/SKILL.md
Status: Phase 11-4B — implemented in Cursor Adapter v1

Git freeze is not a workflow — GIT_FREEZE_PROCEDURE.md.

Workflow IDERP classCatalog IDInvokerReportAdapter path
workflow-bootstrapBootstrap VerificationbootstrapDeveloper + ArchitectB.cursor/skills/bootstrap/SKILL.md
workflow-discoveryArchitecture DiscoverydiscoveryArchitectB.cursor/skills/discovery/SKILL.md
workflow-specArchitecture SpecificationspecArchitectB.cursor/skills/spec/SKILL.md
workflow-phasePhase ImplementationphaseArchitectA.cursor/skills/phase/SKILL.md
workflow-reviewReview PreparationreviewDeveloper (+ optional Delegation)A or B.cursor/skills/review/SKILL.md
workflow-hardeningHardeninghardeningArchitect → DeveloperA.cursor/skills/hardening/SKILL.md
workflow-freezeFreeze PreparationfreezeArchitectB.cursor/skills/freeze/SKILL.md
workflow-releaseRelease DocumentationreleaseDocumentation role + ArchitectB.cursor/skills/release/SKILL.md
workflow-reportReport GenerationreportAll implementation passesA or B.cursor/skills/report/SKILL.md
workflow-statusStatus VerificationstatusDeveloper (+ optional Delegation)B-aligned.cursor/skills/status/SKILL.md

Each workflow cites RuntimeWorkflowContract, requires explicit user invocation (disable-model-invocation: true), and produces Format A or Format B ERP Runtime Reports only. Template authority remains in prompts/commands/.

Legacy EOS aliases: /bootstrap, /discovery, /spec, /phase, /review, /hardening, /freeze, /release, /report, /status


9. Prompt library

TemplatePath
Architecture discoveryprompts/phases/architecture-discovery.md
Architecture specificationprompts/phases/architecture-specification.md
Foundationprompts/phases/foundation.md
Hardeningprompts/phases/hardening.md
Freeze reviewprompts/phases/freeze-review.md
Git freeze (Developer)prompts/phases/git-freeze.md
Architecture reviewprompts/phases/architecture-review.md
Documentation reviewprompts/phases/documentation-review.md

10. Templates

TemplatePath
Discoverytemplates/discovery.md
Specificationtemplates/specification.md
Implementation reporttemplates/implementation-report.md
Architecture reviewtemplates/architecture-review.md
Freeze reviewtemplates/freeze-review.md
Release notestemplates/release-notes.md
Decision recordtemplates/decision-record.md

11. Knowledge hierarchy

Canonical path: knowledge/ (intentional — groups operational knowledge under one subtree; see knowledge/README.md).

AreaPathStatus
Indexknowledge/README.mdNavigation
Patternsknowledge/patterns/Structure only
Playbooksknowledge/playbooks/Pointers to procedures
Recipesknowledge/recipes/Structure only
ADRknowledge/adr/Structure only
Lessonsknowledge/lessons/Structure only
Assetsknowledge/assets/Template links
Decision recordsknowledge/decision-records/EOS engineering decisions

12. Runtime Context Providers

Contract: RuntimeContextProviderContract · phase-11-engineering-runtime-contracts.md §9
Canonical inventory: context-providers-manifest.md
Configuration template: .cursor/mcp/mcp.config.template.json.cursor/mcp.json (Developer local, gitignored)
Adapter mapping: cursor-adapter-v1-profile.md
Status: Phase 11-7 — configuration layer implemented · all providers disabled pending Architect approval

DocumentRole
context-providers-manifest.mdCanonical provider inventory
.cursor/mcp/governance.mdAdapter governance policy
.cursor/mcp/registry.mdAdapter registry summary
.cursor/mcp/manifest.mdAdapter mirror pointer
mcp-governance.mdRepository pointer
mcp-registry.mdRepository pointer

Immediate tier (disabled)

Provider IDNameAccessEnabledTemplate
provider-githubGitHubread-onlyNo.cursor/mcp/providers/provider-github.json
provider-laravel-docsLaravel Docsread-onlyNo.cursor/mcp/providers/provider-laravel-docs.json
provider-php-docsPHP Docsread-onlyNo.cursor/mcp/providers/provider-php-docs.json

Fail-closed: No committed .cursor/mcp.json. Runtime Enforcement denies MCP until Developer enables locally after Architect approval. No write-capable providers. No secrets in Git.


12A. Runtime Execution

Contract: RuntimeExecutionContract · phase-11-engineering-runtime-contracts.md §10
Canonical inventory: execution-manifest.md
CLI configuration: .cursor/cli.json
Cloud configuration: .cursor/environment.json
Adapter mapping: cursor-adapter-v1-profile.md
Status: Phase 11-8 — execution layer implemented · subordinate to all prior ERP layers

DocumentRole
execution-manifest.mdCanonical execution mode inventory
.cursor/execution/manifest.mdAdapter mirror pointer
.cursor/cli.jsonCLI permission overlay
.cursor/environment.jsonCloud bootstrap config

Execution modes

Execution IDModeNative artifactOwner
execution-localLocalCommitted .cursor/ workspaceDeveloper IDE session
execution-cliCLI.cursor/cli.jsonDeveloper terminal
execution-cloudCloud.cursor/environment.json + dashboardCursor Cloud VM
execution-backgroundBackgroundInherits parent .cursor/ mirrorAsync continuation

Boundaries: Execution hosts ERP components from committed mirror — does not replace governance. No Git freeze from remote. No autonomous Architect review. No secrets in committed execution config.


13. Phase delivery status

Phase 10 (EOS v1.0)

Sub-phaseStatus
10-1 DiscoveryComplete
10-2 SpecificationComplete
10-3 FoundationComplete
10-4 Content ReviewComplete
10-5 RefinementComplete
10-6 ValidationComplete
10-7 HardeningComplete
10-8 Freeze PreparationComplete
10-9 Git FreezePending — Developer only

Phase 11 (ERP v1.0)

Sub-phaseStatus
11-1 DiscoveryComplete
11-2 SpecificationComplete
11-2A Runtime-agnostic refinementComplete
11-2B Documentation alignmentComplete
11-2C Runtime ContractsComplete
11-3 Adapter version control & constraintsComplete
11-4 Procedures & workflows specificationComplete
11-4A Runtime Procedures (RuntimeProcedureContract)Complete
11-4B Runtime Workflows (RuntimeWorkflowContract)Complete
11-5 Runtime Delegation (RuntimeDelegationContract)Complete
11-6 Runtime Enforcement (RuntimeEnforcementContract)Complete
11-7 Runtime Context Providers (RuntimeContextProviderContract)Complete
11-8 Runtime Execution (RuntimeExecutionContract)Complete
11-9 Validation & freeze prepComplete — ERP v1.0 validated; Ready for Phase 11-10
11-10 Acceptance, DX & freeze preparationComplete — developer guides · RESPONSE_TEMPLATE v2 (nine sections)
11-11 Git FreezePending — Developer only — tag v5.1-engineering-runtime-platform

14. Version control policy (adapter workspace)

Current state: Enacted Phase 11-3.cursor/ engineering assets are tracked in Git. Secrets and local overrides excluded — see .cursor/VERSION_CONTROL.md.

Belongs in Git (when policy enacted — Adapter v1)

PathERP component
.cursor/rules/Runtime Constraints
.cursor/skills/Runtime Procedures + Runtime Workflows
.cursor/agents/Runtime Delegation stubs
.cursor/hooks.json + .cursor/hooks/Runtime Enforcement
.cursor/mcp/mcp.config.template.json + .cursor/mcp/providers/Runtime Context Providers (templates — no secrets)
.cursor/mcp/governance.md, .cursor/mcp/registry.md, .cursor/mcp/manifest.mdContext provider policy
.cursor/environment.json · .cursor/cli.json · .cursor/execution/manifest.mdRuntime Execution
.cursor/manifest/Adapter workspace manifest

docs/development/ manifests, prompts, templates, ERP spec, and adapter profiles always belong in Git — canonical repository truth for EOS and ERP Core.

Never belongs in Git

ItemRationale
MCP tokens, API keys, credentialsSecrets — Developer local only
.cursor/mcp.jsonLocal enablement with env bindings — gitignored
Personal IDE user settingsNot engineering assets
Chat history or session exportsNot repository truth

Rationale

EOS and ERP principle "Repository Is Truth" requires shareable engineering assets in Git. Adapter v1 workspace tracking enacted in Phase 11-3. Exclude .cursor/mcp.json and local override patterns only.


Permanent engineering asset index for ZAIXOS. Update at EOS/ERP amendments and freeze phases.

ZAIXOS Knowledge Portal — public engineering docs at /docs · Staff operations at /admin