Skip to content

Publish the CoreLink v1 30-minute quickstart - #8

Draft
jaavid wants to merge 5 commits into
mainfrom
agent/docs-02-quickstart
Draft

Publish the CoreLink v1 30-minute quickstart#8
jaavid wants to merge 5 commits into
mainfrom
agent/docs-02-quickstart

Conversation

@jaavid

@jaavid jaavid commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Related: #3

What changed

  • publishes a contract-backed 30-minute v1 quickstart for bearer auth, tenant scoping, Device and Command calls
  • documents the current credential boundary without inventing a token-issuance endpoint
  • covers idempotent command submission, standard problem responses, safe retries and tenant-isolation verification
  • links the quickstart from the versioned docs indexes
  • extends Documentation CI with contract markers from the quickstart

Contract boundary

Targets the current 1.0.0-draft public Device + Command slice. TypeScript/Python remain prerelease Alpha; no Stable SDK or production endpoint is claimed.

Validation

Local equivalent of Documentation CI passed:

  • versioned docs and quickstart files present
  • 1.0.0-draft and corelink_device_id retained
  • Bearer auth, tenant-scoped Device path and Idempotency-Key markers verified

GitHub Actions

Documentation CI run 31123081823 was re-run on head 88ae7da456d8c8abdf2c0d2a1e84aa5e467c5e3a; the validate check completed successfully on 2026-08-11.

Remaining gate

This PR remains Draft intentionally. CI is no longer the blocker; promotion/merge should follow reconciliation with the accepted contract slice and DOCS-02 product acceptance boundary rather than treating a green documentation check as contract acceptance.

jaavid commented Aug 10, 2026

Copy link
Copy Markdown
Contributor Author

Governance revalidation required — 2026-08-10

The PR body still lists the earlier GitHub Actions incident as the reason Documentation CI evidence is pending. That blocker is stale: hosted Actions are functioning again across the organization.

Before merge, rebase/revalidate this quickstart against current main and the current 1.0.0-draft API/SDK maturity baseline, then run this repository's Documentation CI and retain its run as DOCS-02 acceptance evidence. Cross-repository CI success should not substitute for repository-local validation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant