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

Plugin Documentation Refresh #2142

Closed
garrettjstevens opened this issue Jul 20, 2021 · 2 comments · Fixed by #3138
Closed

Plugin Documentation Refresh #2142

garrettjstevens opened this issue Jul 20, 2021 · 2 comments · Fixed by #3138

Comments

@garrettjstevens
Copy link
Collaborator

Along with plugin updates (#2046, #2114, or similar), we need to refresh our plugin documentation to help users be able to easily create JBrowse plugins. We need to document examples of the following types of plugin development workflows:

  • Simple no-build plugin that is just a single file that does something like add or alter menu items, etc.
  • Plugin using the jbrowse-plugin-template build system that does more complex things like use TypeScript, bundle in a dependency, etc. This plugin might e.g. add a new display type.
  • Plugin using the jbrowse-plugin-template build system that does desktop-specific actions like running a CLI tool, parsing the results, and displaying them in JBrowse.

For future discussion: how to arrange these different workflow docs on our website.

@garrettjstevens
Copy link
Collaborator Author

From the meeting: add a "Developer Tutorials" section to the docs that has each tutorial as a page under that section.

@cmdcolin
Copy link
Collaborator

cmdcolin commented Apr 7, 2022

now that no-build plugins work might be good to get an example of this

JBrowse team board automation moved this from Prioritized to Done Sep 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging a pull request may close this issue.

2 participants