Skip to content

[DOCS-02] Publish 30-minute authentication, tenant, device, and command quickstart #3

Description

@jaavid

Background

CoreLink is managed as one product across multiple implementation repositories. This work is the executable feature owned by developer-docs under EPIC-05.

Problem

The repository now contains the contract-backed 30-minute quickstart, but Product Acceptance still requires a retained end-to-end run proving a new developer can complete the supported journey within the target time.

Goal

Publish and validate a 30-minute authentication, tenant, device, and command quickstart with observable acceptance evidence and no divergence from the product-level contract.

Parent

  • Primary Product Epic: EPIC-05
  • Backlog ID: DOCS-02

Scope

  • Maintain the quickstart within the developer-docs implementation boundary.
  • Reconcile it with the version-identifiable authentication, tenant, Device and Command contract slice.
  • Retain runnable evidence suitable for the Developer Platform product gate.

Out of Scope

  • Creating a separate repository roadmap.
  • Expanding into adjacent product domains without an accepted Product Epic or decision record.
  • Treating documentation CI or a merged document alone as Developer Platform acceptance.

Acceptance Criteria

  • A new developer can complete the supported authentication, tenant, device and command journey from the documented quickstart in 30 minutes or less.
  • Examples are versioned and aligned with the current 1.0.0-draft Device/Command contract boundary.
  • Expected, failure and recovery paths are documented where they materially affect the journey.
  • Tenant isolation, authorization and sensitive-data handling are documented accurately for the current contract boundary.
  • Links, examples and version claims pass the accepted documentation-integrity validation revision.
  • Retained end-to-end execution evidence is linked and EPIC-05 exit criteria are measurably advanced.

Technical Notes

Preserve canonical identifiers and provider-neutral public behavior. Do not advertise draft/scaffold capability as a Stable release.

Dependencies and acceptance state

  • Prerequisite completed: DOCS-01 established the versioned documentation information architecture.
  • Implementation completed: PR #9 merged the validated 30-minute quickstart on 2026-08-29, superseding the earlier draft PR Publish the CoreLink v1 30-minute quickstart #8.
  • Documentation expansion completed: PR #11 added architecture, auth/tenancy, Device/Command, compatibility, maturity and troubleshooting context around the quickstart.
  • Validation hardening: DOCS-05 / PR ci: validate documentation integrity #12 adds repository-wide documentation-integrity checks; its accepted CI result is required for the corresponding validation criterion.
  • Remaining product gate: execute and retain a real supported-environment developer run measuring the <=30 minute outcome. A green documentation check alone is not that evidence.
  • Blocks: EPIC-05 developer onboarding acceptance and downstream quickstart-derived examples.
  • Current dependency state: See the CoreLink Product organization Project.

Planning Metadata

  • Type: Feature
  • Priority snapshot: P0
  • Product milestone snapshot: Developer Platform
  • Domain snapshots: docs, devex
  • Area snapshot: documentation
  • Complexity: L
  • Created in status: Triage
  • Current status and DRI: See the CoreLink Product organization Project.
  • Intended repository labels: type:feature

Definition of Done

  • Acceptance criteria demonstrated.
  • Runnable quickstart evidence is retained and linked.
  • Contract/version claims are reconciled in the merged documentation.
  • Security and tenant boundaries are documented for the current public slice.
  • Documentation validation passes on the accepted revision.
  • Related examples and release/maturity notes are updated in the merged v1 docs.
  • Documentation pull requests are merged and linked.

Metadata

Metadata

Assignees

No one assigned

    Labels

    type:featureUser-visible product capability or outcome

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions