ZAIXOS Enterprise Engineering Documentation
Live site: https://zaixos.com/docs (requires Laravel Herd — run herd secure zaixos.com once if HTTPS fails)
Local preview (no Herd): npm run docs:dev → http://localhost:5173/docs/
Deploy to zaixos.com: npm run docs:deploy (builds + copies to zaixos-company-platform/public/docs)
Status: Official internal knowledge base
Authority: ZAIXOS Engineering Platform (PL-001)
Maintainers: Platform Architecture · Documentation Guild
Last updated: 2026-07-05
Purpose
This is the official Engineering Knowledge Base for the entire ZAIXOS ecosystem — not project READMEs, not ad-hoc developer notes, not chat memory.
Comparable in intent to Google Engineering, Stripe Docs, Shopify Engineering, Microsoft Learn, and AWS Architecture Center — scoped to ZAIXOS platforms, products, agents, and governance.
A new engineer should understand the ecosystem by reading this documentation alone.
Start here
| Audience | Entry point |
|---|---|
| New engineer | INDEX.md → ENGINEERING/onboarding.md |
| Architect | ARCHITECTURE/README.md → ADR/README.md |
| AI engineer | AI/README.md → PLATFORMS/PL-003-ai-runtime.md |
| Product engineer | PRODUCTS/README.md → your PRD |
| QA / Release | TESTING/README.md → GOVERNANCE/release-governance.md |
Authority chain
When documents conflict, resolve in this order:
docs/releases/— frozen baselinescore/constitution/— platform constitutiondocs/(this knowledge base) — engineering truthzaixos-company/— corporate & portfolio authority (cite only)- Product repositories — domain documentation
knowledge/— operational playbooks
See GOVERNANCE/authority-chain.md.
Navigation
docs/
├── INDEX.md ← Master index
├── VISION/ ← Long-term direction
├── COMPANY/ ← Cite-only company pointers
├── ENGINEERING/ ← Philosophy, principles, workflows
├── ARCHITECTURE/ ← System design, diagrams, boundaries
├── PLATFORMS/ ← PL-001 … PL-006
├── PRODUCTS/ ← PRD-000, PRD-001, …
├── MODULES/ ← Bounded contexts
├── AGENTS/ ← Agent catalog
├── CAPABILITIES/ ← Capability catalog
├── AI/ ← AI lifecycle & closed loop
├── API/ ← Contract surfaces
├── DATABASE/ ← Schema ownership
├── EVENTS/ ← Domain & integration events
├── SECURITY/ ← Auth, audit, AI safety
├── DEPLOYMENT/ ← Environments & release
├── DEVOPS/ ← CI, infra, observability ops
├── TESTING/ ← Test strategy & suites
├── QA/ ← Quality gates
├── STANDARDS/ ← Templates & writing rules
├── GOVERNANCE/ ← Ownership, compliance, reports
├── ADR/ ← Architecture Decision Records
├── ROADMAPS/ ← Documentation & product roadmaps
├── TUTORIALS/ ← How-to guides
├── REFERENCE/ ← Indexes & lookup tables
└── CHANGELOG/ ← Documentation change logFederated sources
This portal indexes and cites — it does not duplicate product bodies.
| Source | Role |
|---|---|
| ENGINEERING_INDEX.md | Legacy ERP asset map (superseded by INDEX.md for navigation) |
| zaixos-registry | Machine-readable indexes |
| zaixos-company | Portfolio & company constitution |
| Consumer repos | Product-specific deep docs |
Contributing
All new documentation must use STANDARDS/templates/ and follow STANDARDS/documentation-quality.md.
Documentation-only changes do not require architecture approval unless they alter governance truth.