Knowledge Portal · engineering documentation

Skip to content

ZAIXOS Engineering Platform — Repository Layout Plan

Document type: Extraction Planning Specification
Version: 1.0 · Phase: 12-4
Status: Permanent execution authority
Target repo: zaixos-engineering-platform
Architecture reference: technical/PACKAGE_ARCHITECTURE.md (normative — not redesigned)


Purpose

Define the final repository structure after extraction and scaffold (Phase 12-5). This is the tree implementers create — content populated in Phase 12-6.


Repository metadata

FieldValue
Repository namezaixos-engineering-platform
Primary branchmain
Release tagszaixos-platform@vMAJOR.MINOR.PATCH
Composer namezaixos/engineering-platform
Minimum PHP^8.2
LicenseProprietary (ZAIXOS)

Complete directory tree (post-scaffold + post-extraction)

zaixos-engineering-platform/
├── README.md
├── CHANGELOG.md
├── composer.json
├── phpunit.xml.dist
├── .gitignore

├── core/
│   ├── constitution/
│   │   ├── PLATFORM_CONSTITUTION.md
│   │   ├── PLATFORM_BOUNDARIES.md
│   │   ├── PLATFORM_PUBLIC_API.md
│   │   ├── PLATFORM_EXTENSION_MODEL.md
│   │   ├── PLATFORM_VERSIONING_POLICY.md
│   │   └── PLATFORM_INDEX.md
│   ├── methodology/
│   │   ├── DEVELOPMENT_WORKFLOW.md
│   │   ├── RESPONSE_TEMPLATE.md
│   │   ├── GIT_FREEZE_PROCEDURE.md
│   │   └── CONTEXT_FILE_POLICY.md
│   └── index/
│       └── PLATFORM_INDEX.md          # symlink or canonical copy

├── docs/
│   ├── developer-guide.md
│   ├── runtime-validation.md
│   ├── acceptance-checklist.md
│   ├── platform/
│   │   └── adr/                       # ADR-001 … ADR-005
│   ├── product/                       # from docs/platform/product/
│   ├── technical/                     # from docs/platform/technical/
│   ├── planning/                      # from docs/platform/planning/
│   ├── migrations/                    # v1→v2 guides (future)
│   └── releases/
│       └── v1.0.0.md                  # compatibility matrix per release

├── contracts/
│   ├── runtime-contracts.md           # contracts@1
│   └── schemas/
│       └── *.json

├── runtime/
│   ├── specification/
│   │   ├── engineering-runtime-platform.md
│   │   └── archive/                   # historical phase specs
│   ├── components/
│   │   ├── constraints.md
│   │   ├── procedures.md
│   │   ├── workflows.md
│   │   ├── delegation.md
│   │   ├── enforcement.md
│   │   ├── context-providers.md
│   │   └── execution.md
│   └── manifests/
│       ├── schemas/
│       └── defaults/
│           ├── procedures-manifest.md
│           ├── workflows-catalog.md
│           ├── delegation-manifest.md
│           ├── runtime/manifests/defaults/enforcement-manifest.md
│           ├── runtime/manifests/defaults/context-providers-manifest.md
│           └── runtime/manifests/defaults/execution-manifest.md

├── adapters/
│   └── cursor-adapter-v1/
│       ├── profile.md
│       ├── manifest.json
│       ├── capability-gaps.md
│       └── workspace/                 # full .cursor/ tree
│           ├── rules/
│           ├── skills/
│           ├── agents/
│           ├── hooks/
│           ├── hooks.json
│           ├── cli.json
│           ├── environment.json
│           ├── mcp/
│           └── manifest/

├── templates/
│   ├── implementation-report.md
│   ├── architecture-review.md
│   ├── specification.md
│   ├── discovery.md
│   ├── freeze-review.md
│   ├── release-notes.md
│   ├── decision-record.md
│   └── prompts/
│       ├── phases/
│       └── commands/

├── knowledge/
│   ├── patterns/
│   ├── playbooks/
│   ├── recipes/
│   └── lessons/

├── validation/
│   ├── tests/
│   │   ├── ContractComplianceTest.php
│   │   ├── ManifestParityTest.php
│   │   ├── AdapterWorkspaceTest.php
│   │   ├── ExtensionSchemaTest.php
│   │   ├── ConfigSchemaTest.php
│   │   ├── ChecksumIntegrityTest.php
│   │   ├── EngineeringRuntimePlatformIntegrityTest.php
│   │   └── EngineeringOperatingSystemIntegrityTest.php
│   ├── fixtures/
│   │   └── minimal-product/           # synthetic .zaixos/ layout for CI
│   └── src/
│       └── Support/
│           ├── ErpIntegritySupport.php
│           └── EosIntegritySupport.php

└── schemas/
    └── config/
        ├── platform-yml.schema.json
        ├── platform-lock.schema.json
        ├── extensions-manifest.schema.json
        ├── adapter-manifest.schema.json
        └── examples/
            ├── platform.yml
            ├── platform.lock
            └── extensions-manifest.yml

Files explicitly NOT in platform repo

PathReason
app/Product application
database/migrations (clinic)Product
tests/Architecture/ModuleBoundaryTest.phpProduct
.zaixos/ consumer instanceLives in product repos
Product AGENTS.mdProduct

CI layout (platform repo — 12-5 scaffold)

.github/workflows/
├── validate.yml          # phpunit validation/ on every PR
└── release.yml           # tag + packagist publish (12-9)

Composer autoload (scaffold)

json
{
  "autoload": {
    "psr-4": {
      "Zaixos\\Platform\\Validation\\": "validation/src/"
    }
  },
  "autoload-dev": {
    "psr-4": {
      "Zaixos\\Platform\\Validation\\Tests\\": "validation/tests/"
    }
  }
}

Index documents (entry points)

AudiencePath
Platform architectcore/constitution/PLATFORM_CONSTITUTION.md
Developerdocs/developer-guide.md
Integratordocs/technical/TECHNICAL_INDEX.md
Extraction historydocs/planning/PLANNING_INDEX.md

Repository Layout Plan v1.0 — Phase 12-4. Implements PACKAGE_ARCHITECTURE without modification.

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