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.

Sign up for GitHub

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

Jump to bottom

Auto-generate plugin options documentation #3183

Open
michaelpj opened this issue Sep 17, 2022 · 3 comments · May be fixed by #4414
Open

Auto-generate plugin options documentation #3183

michaelpj opened this issue Sep 17, 2022 · 3 comments · May be fixed by #4414
Assignees
@develop7
Labels
documentation Hackathon This issue is suitable for hackathon sessions level: easy The issue is suited for beginners type: enhancement New feature or request

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

@andys8 andys8 mentioned this issue Sep 17, 2022
Closed
@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.

@michaelpj michaelpj mentioned this issue Nov 2, 2022
Open
@michaelpj michaelpj mentioned this issue Nov 14, 2022
Closed
@michaelpj michaelpj added the Hackathon This issue is suitable for hackathon sessions label May 17, 2023
@develop7 develop7 moved this from Todo to In Progress in HLS & Friends Zurihac Jun 9, 2024
@develop7 develop7 linked a pull request Oct 8, 2024 that will close this issue
Open
@develop7
Copy link
Contributor

@michaelpj #4414 is finally ready for review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@develop7 develop7

Labels
documentation Hackathon This issue is suitable for hackathon sessions level: easy The issue is suited for beginners type: enhancement New feature or request
Projects
HLS & Friends Zurihac
Status: In Progress
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Generate custom parameters' documentation for plugins develop7/haskell-language-server
2 participants
@develop7 @michaelpj