Skip to content

decree-docs: documentation, example outputs, freshness CI #920

Description

@zeevdr

Description

User-facing documentation for the tool: a README in contrib/decree-docs, a page in the MkDocs site, and committed example outputs (md, mdx, html, json) generated from a fixture schema that covers every field type and option. A CI job regenerates the examples and fails on diff, following the generated-docs freshness pattern established in #880.

Acceptance criteria

  • README documents all formats, flags, config keys, and theming options.
  • MkDocs site page added and listed in the mkdocs.yml nav.
  • Committed example outputs for every format, generated from a full-coverage fixture schema.
  • Test coverage: CI regen-diff job fails when committed examples are stale.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    ciCI/InfrastructuredocsDocumentationpriority: P2Nice-to-havesize: MModerate — a day or two, clear scope

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions