Skip to content

REPOSITORY_MATURITY.md

Latest commit

 

History

History
66 lines (49 loc) · 7.1 KB

REPOSITORY_MATURITY.md

File metadata and controls

66 lines (49 loc) · 7.1 KB
Raw

CoreLink repository maturity inventory

Last reconciled: 2026-08-30

CoreLink is one product delivered through multiple repositories. This inventory records repository role and maturity; it is not a second product roadmap. Product goals, milestones, cross-repository Epics, and acceptance decisions remain authoritative in product-planning.

Maturity vocabulary: Scaffold, Experimental, Alpha, Beta, Stable, Deprecated, Planned. Repository visibility, source-code volume, a merged PR, or a release tag does not by itself establish Stable/commercial support.

Active repository inventory

Repository Product role Current maturity Current meaning
platform Core runtime Alpha / implemented foundation Substantial tenancy, identity, device, command, telemetry/event, commercial and operational foundations exist; hosted-alpha and product acceptance gates remain active.
Console Hosted tenant/customer SaaS console Alpha Deployable tenant-facing Console exists with OIDC/BFF and operational journeys. Provider implementation details are not part of its product contract.
Control Private platform control plane / operator UI Alpha Internal privileged operations surface for platform overview, tenants, devices, managed connections and diagnostics. It is not a tenant/customer portal and must remain fail-closed to non-platform actors.
api-contracts Public/admin/internal API and event contracts Alpha · 1.0.0-draft public boundary Device + Command public slice and canonical event envelope are reviewable; broader v1 contract work is ongoing.
developer-docs Versioned developer documentation Alpha Versioned v1 IA exists; quickstart and broader guides are being reconciled with supported contract/runtime maturity.
sdk-typescript TypeScript client Prerelease Alpha Generated client exists with immutable tagged-contract provenance and successful Blacksmith regeneration/build; supported package/conformance gates remain open.
sdk-python Python client Prerelease Alpha Generated client exists with immutable tagged-contract provenance and successful Blacksmith regeneration/compile; supported publication/conformance and license-policy gates remain open.
sdk-java Java client Experimental · Generated baseline Java 17+, coordinates and reproducible OpenAPI generation/build are defined and pass Blacksmith CI; no supported public Maven artifact or Stable compatibility claim exists yet.
cli Developer/operator CLI Scaffold · Planned No installable supported CLI exists yet.
mock-server Local/CI contract simulation Scaffold · Planned No supported mock runtime/package exists yet; it must consume reviewed versioned contracts.
mcp-server Agent/MCP integration Scaffold · Planned No supported MCP package/tool surface exists yet; security and read-only boundaries are backlog-gated.
website Public product website Active public surface / Alpha claims GitHub Pages is the supported production path; public claims must mirror this inventory and retained evidence.
product-planning Product governance Source of truth Owns product hierarchy, milestone gates, risks, cross-repository Epics and acceptance decisions.
.github Organization governance/community health Source of truth Owns organization profile, maturity, contribution/security/support/release policy and shared templates.

Active repositories: 14. The archived demo-repository is excluded from active-product coverage.

Console and Control are documented capitalized naming exceptions retained to avoid breaking existing links, release automation and deployment references. New repositories should continue to use lowercase kebab-case.

There is currently no standalone CoreLinkPlatform/examples repository. Runnable examples must not be advertised as a separate repository until one is deliberately created, versioned, and accepted.

Product-surface boundary

  • Console is the canonical tenant/customer/partner/reseller product surface.
  • Control is a separate private privileged platform-operator surface. Tenant roles do not imply Control access.
  • Provider identities, raw provider payloads and infrastructure diagnostics may appear in Control when operationally necessary, but remain implementation details and must not become tenant-facing public contracts.

Public capability boundary

The public developer boundary remains intentionally narrower than the private runtime foundation:

  • public API contract: Device + Command on 1.0.0-draft;
  • public event contract: canonical event envelope;
  • TypeScript/Python clients: prerelease Alpha with immutable regeneration provenance;
  • Java client: Experimental generated baseline; no supported artifact channel yet;
  • Console: Alpha hosted application;
  • Control: private Alpha operator surface and not a public developer API contract;
  • CLI/mock/MCP: Scaffold/Planned;
  • telemetry/location, partner operations, usage/billing, automation/media and other surfaces require version-identifiable contract/runtime/release evidence before Stable support claims.

Ownership and review

  • Product planning owns milestone and product-maturity decisions.
  • Each implementation repository owns implementation evidence, local development/deployment documentation, and its repository README.
  • Control requires explicit platform-operator ownership/security review because it aggregates cross-tenant and provider/infrastructure diagnostics.
  • api-contracts owns normative machine-readable API/event schemas and compatibility policy.
  • developer-docs owns human-facing tutorials, concepts, guides, examples, and developer troubleshooting.
  • website and the organization profile summarize maturity but must link to authoritative sources rather than becoming independent roadmaps.
  • A maturity change must reconcile affected docs, website/profile copy, package metadata, compatibility matrices, stack manifests and release evidence.
  • Exceptions are explicit product/governance decisions, not hidden marketing or repository-local wording.

Reconciliation cadence

Review this inventory at every product milestone gate and whenever a repository enters or leaves Scaffold/Experimental/Alpha/Beta/Stable/Deprecated status, or when an active repository is created/archived. Contract compatibility, runtime evidence, documentation, and owning-repository acceptance must agree.