Skip to content

Generate cross-language documentation for settings #1473

@ok-nick

Description

@ok-nick

It's difficult to properly document settings in a way that is accessible to all languages. I propose that we leverage the work in #1447 to add JSON schemas to all our settings and auto-generate documentation via jsonschema2md. We can use the markdown to render it on our website.

The same concept can also be applied to our other structs such as for manifest definitions, assertions, reports, etc.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions