Skip to content

[1.0] Extend project-authoring golden journey and documentation drift coverage #360

Description

@jeremi

Context

The five init-able project starters have generated documentation snippets and anti-drift checks. Additional maintained golden workspaces, including Relay-only, Notary-only, snapshot-with-records, and country-variant OpenCRVS journeys, still rely on hand-maintained prose or partial workflow tests.

The primary project-authoring tutorial also remains marked as draft. This is a coverage and discoverability follow-up, not a reason to add fake starters for workspaces that are intentionally not starter templates.

Scope

  • Map each maintained golden workspace to the workflow steps it genuinely supports: init, test, trace, watch, check with explanation, and build.
  • Add missing success and negative tests only for supported steps.
  • Generate or mechanically validate documentation snippets for non-starter golden workspaces without pretending they support init.
  • Finish and publish the primary Registry Stack project-authoring tutorial, remove its draft status, and link it from the main author path.
  • Preserve the distinction between offline fixture evidence and live integration evidence.

Acceptance criteria

  • Every documented command for a maintained golden workspace is exercised by an automated check.
  • Relay-only and Notary-only topologies have successful check and build proof, plus fixture proof where fixtures apply.
  • Snapshot and country-variant examples cannot drift silently from their schemas or CLI flags.
  • Non-starter workspaces are never advertised as init-able starters.
  • The primary project-authoring tutorial is published, reachable from the main documentation author path, and uses only commands covered by automated checks.
  • OpenSPP remains offline-fixture-only until the owner-run holdout in Complete the owner-run OpenSPP live authoring holdout for 1.0 #357.

Related work

Metadata

Metadata

Assignees

No one assigned

    Labels

    1.0-blockerBlocks the 1.0 release intent.area:docsDocumentation site ownership.area:registryctlregistryctl ownership.criticality:p3Priority/criticality P3.documentationImprovements or additions to documentationtriage:roadmapRoadmap triage.

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions