-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Do we need to track duplicated plugin descriptions in options.md
& plugins.md
?
#3217
Comments
I am currently working on a little utility that automatically generates the markdown docs for the plugin API exposed in |
Currently sounds a bit overdone. At the end it still exists twice and most probably not everyone does the "editing" of the doc via the utility/tool/script etc. |
Yeah, the main reason I'm doing the thing in the first place is so that we can have nice docs for plugin authors that cover the parts of the API that are currently scattered around on pkg.go.dev. I'm also hoping that it would be less work in the long run, because I'm going to source all of the documentation from the comments that already exist in the codebase. Either way, I'll host the thing on github pages whenever it's done, as a sort of unofficial plugin reference. If it works out well, maybe we can reconsider, but I do concur that it might be overkill. I just get a bit excited about using code as data like that :) Back on topic:
I think this makes a lot of sense, even though it kinda sucks that things need to be maintained in two separate places. In fact, I totally missed that in #3240. I'll have to check if it needs to be corrected. Maybe (I realize that this doesn't actually solve the duplication at all, but at least like this there is some added value?) |
Do we really need to track the same description twice?
micro/runtime/help/options.md
Lines 471 to 481 in 838f371
micro/runtime/help/plugins.md
Lines 416 to 426 in 838f371
I would prefer to track it in one file only and since they are related to plugins the
plugins.md
would fit the most.There are already votes against the removal:
The text was updated successfully, but these errors were encountered: