Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto-generate plugin options documentation #3183

Open
michaelpj opened this issue Sep 17, 2022 · 2 comments
Open

Auto-generate plugin options documentation #3183

michaelpj opened this issue Sep 17, 2022 · 2 comments
Labels
documentation level: easy The issue is suited for beginners type: enhancement New feature or request ZuriHac This issue is suitable for ZuriHac Hacking sessions

Comments

@michaelpj
Copy link
Collaborator

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.

@michaelpj
Copy link
Collaborator Author

Related: #3156

@michaelpj michaelpj added the level: easy The issue is suited for beginners label Nov 2, 2022
@michaelpj
Copy link
Collaborator Author

I think this wouldn't be too hard. We already have some code that turns the plugin config into a vscode extension schema, we could write a very similar piece of code that turned it into e.g. a markdown table.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation level: easy The issue is suited for beginners type: enhancement New feature or request ZuriHac This issue is suitable for ZuriHac Hacking sessions
Projects
Development

No branches or pull requests

1 participant