Skip to content

Auto-generate parts of the interface docs from the schemas #355

@james-garner-canonical

Description

@james-garner-canonical

It would be nice if interface library authors didn't need to repeat themselves between the schema and the README.md (see for example #353). It would be best if the schema was the source of truth. It should be straightforward to auto-generate the 'Relation Data' section of interface readme pages from the schema when rendering the docs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    26.10An item we hope to do in the 26.10 cycledocsImprovements or additions to documentationinfraIssues with the repository infrastructure specifically.interfacesRelated to interface specifications specifically.rainy daySmall items done in ~10% of each week's time

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions