Skip to content

decree-docs: inject mode for existing READMEs #919

Description

@zeevdr

Description

An --inject mode writes generated docs between <!-- BEGIN_DECREE_DOCS --> and <!-- END_DECREE_DOCS --> markers in an existing file, leaving surrounding hand-written content untouched (terraform-docs model). This suits keeping a schema section fresh inside a project README via CI or pre-commit.

Acceptance criteria

  • Injection replaces only the marked region and fails with a clear error when markers are missing or unbalanced.
  • Running injection twice on the same input is a no-op (idempotent).
  • Test coverage: unit tests for marker handling (missing, unbalanced, multiple) and an idempotency test.

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

    cliCLI changesenhancementNew feature or requestpriority: P2Nice-to-havesize: SQuick win — a few hours or less

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions