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

"documentation engine" interface tutorial #71

Open
gregcaporaso opened this issue Apr 13, 2024 · 0 comments
Open

"documentation engine" interface tutorial #71

gregcaporaso opened this issue Apr 13, 2024 · 0 comments
Labels
content proposal Proposed new content. interfaces Related to the *Interfaces* part. tutorial Related to a *Tutorial*.

Comments

@gregcaporaso
Copy link
Member

A good interface tutorial could be to develop a "documentation engine", that ultimately could be used to generate plugin documentation for all plugins in a distribution, like the current Available Plugins page in the user docs. This would use the sdk to load the PluginManager, and then explore the different functionality to find the available plugins and write documentation of those plugins. Following development of this, I could fork the example interface repository (caporaso-lab/q2docgen?), and make it available to plugin developers for auto-generating their plugin user documentation.

@gregcaporaso gregcaporaso added interfaces Related to the *Interfaces* part. tutorial Related to a *Tutorial*. content proposal Proposed new content. labels Apr 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content proposal Proposed new content. interfaces Related to the *Interfaces* part. tutorial Related to a *Tutorial*.
Projects
None yet
Development

No branches or pull requests

1 participant