Skip to content

v1.x: generate authoritative CLI, release, and Rust API documentation #168

Description

@projectious

Extracted from the final review of #135. Consolidates former issue #169.

Scope

Define and document the supported developer-facing v1.x surface while removing
manually maintained drift points. Generate CLI help, release facts, and public
Rust API documentation from authoritative implementation sources.

Acceptance criteria

  • User-facing command reference is generated from the shipped CLI.
  • Version, artifact names, checksums, and support status have one authoritative
    source.
  • A public Rust library target exposes the supported v1.x API.
  • Public items have rustdoc and runnable examples.
  • Semver expectations and explicitly unstable/internal modules are documented.
  • Library tests cover the documented primary integration path.
  • CI detects stale generated help, release facts, and API documentation.
  • The docs build consumes generated facts without hand-copied release values.
  • Published package metadata and generated API docs pass release validation.
  • Contributor documentation explains regeneration and review.

Parent: #135

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions