Skip to content

Generate the configuration reference from the settings model #61

Open
Open
Generate the configuration reference from the settings model#61
Labels
documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

Description

@MatthewTracy
MatthewTracy
opened on Aug 4, 2026

Why: manually documented settings can drift from the typed configuration model.

Files: src/yagami/config.py, scripts/, docs/configuration.md.

Acceptance:

  • Generate names, types, defaults, and safe descriptions.
  • Fail CI on drift.
  • Never render secret defaults or runtime values.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions