Skip to content
This repository was archived by the owner on Jul 24, 2026. It is now read-only.

PROJECT.md

Latest commit

 

History

History
64 lines (47 loc) · 2.41 KB

PROJECT.md

File metadata and controls

64 lines (47 loc) · 2.41 KB
Raw

Standard Entity Project

Standard Entity defines a structural TypeScript protocol for type-safe entity operations across libraries without requiring those libraries to import each other.

Lifecycle

  • Lifecycle: production
  • Layer: foundation
  • Doctrine source of truth: SylphxAI/doctrine
  • Doctrine adapter manifest: .doctrine/project.json
  • Vendor-neutral project manifest: project.manifest.json

Goals

  • Provide the @sylphx/standard-entity protocol package and type helpers.
  • Preserve zero-coupling structural interoperability between entity producers and consumers.
  • Keep package exports, README examples, type tests, and release proof aligned.

Non-Goals

  • Do not own Lens, Reify, or downstream product entity models.
  • Do not encode consumer-specific persistence, validation, UI, or workflow semantics into the shared protocol.
  • Do not publish package changes without CI and npm registry readback.

Boundaries

This repository owns the standard entity protocol marker, exported TypeScript types, type guards, package metadata, README contract, and tests. Consumers may depend only on the published package export and documented structural shape.

Public Surfaces

  • @sylphx/standard-entity npm package export in package.json
  • Vendor-neutral project manifest in project.manifest.json
  • Protocol and examples in README.md
  • CI workflow in .github/workflows/ci.yml
  • Release workflow in .github/workflows/release.yml

Project Control

project.manifest.json is the vendor-neutral control file for GroundAtlas and external agents. .doctrine/project.json remains the Sylphx Doctrine adapter and local governance catalog. Generated .groundatlas* files plus GroundAtlas JSON/Markdown reports are evidence and navigation only; they are not source of truth.

Delivery

PRs run the ci workflow, including lint, typecheck, tests, build, project-control boundary checks, and GroundAtlas package dogfooding. Main releases use the organization reusable release workflow from .github/workflows/release.yml. Production proof is CI pass, release workflow completion when publishing, and npm registry readback for changed package versions.

Commercial Direction

not-applicable: this repository is a foundation package/protocol. Commercial pricing, packaging, and roadmap decisions belong to consuming products unless a future ADR changes this package's commercial posture.