Skip to content

Generate configuration documentation automatically from JSON schema #148

Description

@Arthurvdv

Context

Suggestion extracted from PR #147 (Change property names to PascalCase for consistency), submitted by @frottke.

Suggestion

It might also be worth improving the JSON schema itself so that the configuration documentation can be generated automatically from it in the future. This could help prevent the documentation and schema from getting out of sync again, especially when properties are added or renamed.

A tool such as adobe/jsonschema2md could potentially be used to generate Markdown documentation directly from the JSON schema.

Reference

This issue was generated automatically from a PR suggestion for backlog tracking.

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

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions