diff --git a/PUBLIC_CAPABILITY_STATUS.md b/PUBLIC_CAPABILITY_STATUS.md index 7a3f7bf..f02e6e6 100644 --- a/PUBLIC_CAPABILITY_STATUS.md +++ b/PUBLIC_CAPABILITY_STATUS.md @@ -1,29 +1,31 @@ # Public capability claim inventory -This inventory records the evidence boundary used by website copy. Runtime code -and retained executable evidence outrank README, Issue, Project and marketing -copy when they disagree. +This inventory records the evidence boundary used by website copy. Runtime/contract/release evidence outranks README, Issue, Project or marketing copy when they disagree. The organization-wide maturity inventory in `CoreLinkPlatform/.github` is the shared repository-level source of truth. | Public surface | Current maturity | Evidence boundary | | --- | --- | --- | | Public API | Alpha / `1.0.0-draft` | `api-contracts`: reviewed Device + Command slice and canonical event envelope | -| TypeScript SDK | Prerelease Alpha | generated client repository; not a Stable supported release | -| Python SDK | Prerelease Alpha | generated client repository; not a Stable supported release | -| Java SDK | Scaffold / Planned | repository scaffold | -| CLI | Scaffold / Planned | repository scaffold | -| MCP server | Scaffold / Planned | repository scaffold | -| Mock server | Scaffold / Planned | repository scaffold | -| Identity / Device registry / Commands | Alpha | implemented platform foundation; release hardening/evidence still gates Stable | -| Digital twin / Telemetry | Experimental | foundation exists; public product acceptance is incomplete | -| Media | Planned | no supported public v1 media claim | -| White-label experience | Planned | product direction; not a released application boundary | +| CoreLink Console | Alpha | deployable hosted SaaS frontend exists; live support remains gated by Platform/API compatibility and hosted-alpha acceptance evidence | +| TypeScript SDK | Prerelease Alpha | generated client repository; not a Stable supported package | +| Python SDK | Prerelease Alpha | generated client repository; license/support/publication and conformance gates remain open | +| Java SDK | Scaffold / Planned | no supported Java artifact exists | +| CLI | Scaffold / Planned | no installable supported CLI exists | +| MCP server | Scaffold / Planned | no supported MCP package/tool surface exists | +| Mock server | Scaffold / Planned | no supported mock runtime/package exists | +| Identity / tenancy / Device registry / Commands | Alpha | implemented Platform foundation; release/product evidence still gates Stable | +| Telemetry / location / events | Alpha/Experimental by surface | substantial runtime foundation exists; broader public contract and acceptance work remains active | +| Commercial controls / usage | Alpha/Experimental by surface | runtime/Console foundations exist; public contract and customer acceptance remain gated | +| White-label customization/custom domains | Planned | shared Console boundary exists, but deep white-label customization is not a released supported capability | +| Media | Planned / evidence-gated | no supported public v1 media platform claim | -Allowed website maturity terms are **Scaffold, Experimental, Alpha, Beta, -Stable, Deprecated, Planned**. +Allowed website maturity terms are **Scaffold, Experimental, Alpha, Beta, Stable, Deprecated, Planned**. -Device/protocol names shown on the site are evaluation examples. They do not -mean every listed model, firmware or protocol is currently supported. A support -claim requires profile-specific validation evidence. +## Claim rules -Review this inventory whenever runtime/contract/SDK maturity changes and before -a public website release. +- A working Console screen or demo dataset does not prove the corresponding live API is accepted. +- A generated SDK does not prove supported package publication or runtime parity. +- Device/protocol names shown on the site are evaluation examples unless profile-specific support/certification evidence is linked. +- Public API/SDK/tool claims must link to authoritative contract/repository maturity rather than duplicating a roadmap. +- White-label product direction must distinguish the existing shared Console from still-Planned customization/custom-domain capability. + +Review this inventory whenever runtime, contract, Console, SDK/tool maturity changes and before each public website release. \ No newline at end of file diff --git a/README.md b/README.md index bf5f0f2..abbeb92 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Official website for [CoreLink Platform](https://corelinkplatform.ir). ## Supported production path -**GitHub Pages is the only supported production deployment path.** +**GitHub Pages is the supported production deployment path for this website.** - Runtime: static export from Next.js 16 / React 19 / TypeScript. - Build: `npm ci && npm run build`. @@ -12,9 +12,7 @@ Official website for [CoreLink Platform](https://corelinkplatform.ir). - Deployment: `.github/workflows/deploy-pages.yml` on `main`. - Production has no application server or database dependency. -See [DEPLOYMENT.md](DEPLOYMENT.md) for release evidence and rollback, and -[QUALITY_GATES.md](QUALITY_GATES.md) for accessibility, performance, SEO and -analytics-privacy acceptance. +See [DEPLOYMENT.md](DEPLOYMENT.md) for release evidence/rollback, [QUALITY_GATES.md](QUALITY_GATES.md) for accessibility/performance/SEO/analytics-privacy acceptance, and [PUBLIC_CAPABILITY_STATUS.md](PUBLIC_CAPABILITY_STATUS.md) for the public claim inventory. ## Local development @@ -27,17 +25,21 @@ npm test ## Internal preview tooling -The `*:sites` scripts and their Vinext/Wrangler/Vite/Cloudflare dependencies are -retained only for internal preview/tooling experiments. They are **not** a -supported CoreLink production deployment path and must not be used as release -evidence for this website. +The `*:sites` scripts and Vinext/Wrangler/Vite/Cloudflare-related dependencies are retained only for internal preview/tooling experiments. They are **not** a supported CoreLink production deployment path and must not be used as website release evidence. -## Public developer resources +## Public product/developer resources +- [CoreLink Console](https://github.com/CoreLinkPlatform/Console) — Alpha hosted SaaS frontend; live journeys remain compatibility/acceptance-gated. +- [Developer Documentation](https://github.com/CoreLinkPlatform/developer-docs) - [API Contracts](https://github.com/CoreLinkPlatform/api-contracts) - [TypeScript SDK](https://github.com/CoreLinkPlatform/sdk-typescript) - [Python SDK](https://github.com/CoreLinkPlatform/sdk-python) -- [Java SDK](https://github.com/CoreLinkPlatform/sdk-java) -- [CLI](https://github.com/CoreLinkPlatform/cli) -- [MCP Server](https://github.com/CoreLinkPlatform/mcp-server) -- [Mock Server](https://github.com/CoreLinkPlatform/mock-server) +- [Java SDK](https://github.com/CoreLinkPlatform/sdk-java) — Scaffold/Planned +- [CLI](https://github.com/CoreLinkPlatform/cli) — Scaffold/Planned +- [MCP Server](https://github.com/CoreLinkPlatform/mcp-server) — Scaffold/Planned +- [Mock Server](https://github.com/CoreLinkPlatform/mock-server) — Scaffold/Planned +- [Repository Maturity](https://github.com/CoreLinkPlatform/.github/blob/main/REPOSITORY_MATURITY.md) + +## Claim policy + +Website copy must not turn repository visibility, generated code, demo UI, merged implementation or a release tag into a stronger support claim than the authoritative contract/repository/release evidence. Use the shared maturity vocabulary: Scaffold, Experimental, Alpha, Beta, Stable, Deprecated, Planned. \ No newline at end of file