Skip to content

Auto-generate plugin options documentation #3183

Open
@michaelpj

Description

@michaelpj

At the moment we have a hand-written section that lists some of the plugin options. This is not accurate, and it's definitely not sustainable.

We already have the ability to auto-generate an options schema from the plugin options. If we augmented the definitions of plugin options to include some documentation, we could potentially generate a more complete and automatically up-to-date documentation page for plugin options.

Metadata

Metadata

Assignees

Labels

HackathonThis issue is suitable for hackathon sessionsdocumentationlevel: easyThe issue is suited for beginnerstype: enhancementNew feature or request

Type

No type

Projects

Status

In Progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions