Skip to content

[DOCS-04] Publish SDK, CLI, mock, MCP, sandbox, and migration guides #5

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 current repository state does not yet provide verified, release-ready evidence to publish SDK, CLI, mock, MCP, sandbox, and migration guides.

Goal

Publish SDK, CLI, mock, MCP, sandbox, and migration guides with observable acceptance evidence and no divergence from the product-level contract.

Parent

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

Scope

  • Deliver the outcome stated in the title within the developer-docs implementation boundary.
  • Reconcile affected contracts, tests, documentation, security, tenancy, observability, migration and release behavior.
  • Retain acceptance evidence suitable for the Beta product gate.

Out of Scope

  • Creating a separate repository roadmap.
  • Expanding into adjacent product domains without an accepted Product Epic or decision record.
  • Claiming completion based only on code merge when operational or customer validation is required.

Acceptance Criteria

  • The stated outcome is implemented or documented at the correct repository boundary.
  • Expected, failure and recovery paths are covered by repeatable checks or retained evidence.
  • Tenant isolation, authorization and sensitive-data behavior are reviewed where applicable.
  • Public/internal contract and compatibility impacts are reconciled.
  • Documentation, observability, migration/rollback and release notes are updated where applicable.
  • Evidence is attached or linked and the parent Epic exit criteria are measurably advanced.

Technical Notes

Preserve canonical identifiers, provider-neutral public behavior, idempotency and backward compatibility. Prefer the existing modular-monolith boundary unless measured scale, security isolation or ownership requires extraction.

Dependencies

  • Blocked by: Supported releases of referenced tools
  • Blocks: To be resolved during refinement.
  • Cross-repository work: Link concrete Issues during refinement; do not duplicate their implementation here.

Planning Metadata

  • Type: Feature
  • Priority: P1
  • Product milestone: Beta
  • Domains: docs, devex
  • Area: documentation
  • Complexity: L
  • Initial status: Triage
  • DRI: Unassigned
  • Intended labels: type:feature, priority:p1, domain:docs, domain:devex, area:documentation

Definition of Done

  • Acceptance criteria demonstrated.
  • Required tests and evidence pass.
  • Contracts are updated or confirmed unaffected.
  • Security and tenant boundaries are reviewed.
  • Migration and rollback paths are verified where applicable.
  • Observability and runbooks are updated where applicable.
  • Documentation and release notes are updated.
  • Pull request(s) 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