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

New Documentation #437

Open
38 tasks
haoxusci opened this issue Jan 15, 2021 · 0 comments · May be fixed by #440
Open
38 tasks

New Documentation #437

haoxusci opened this issue Jan 15, 2021 · 0 comments · May be fixed by #440

Comments

@haoxusci
Copy link
Collaborator

haoxusci commented Jan 15, 2021

As discussed during the ImJoy hackathon, the current imjoy docs is confusing because we don't have clear separation between different user groups (user, plugin developer and core developer).

Following suggestions from https://www.youtube.com/watch?v=t4vKPhjcMZg and the vscode example (https://code.visualstudio.com/docs/) (Thanks to @MartinHjelmare ), we decided to reorganize the docs to the following structure:

  • Overview
    • Governance model
  • User Guide
    • Tutorial
      • How to install and run a plugin
      • How to run a plugin via the plugin engine
    • How-tos guides
      • How to share a plugin
      • How to setup a plugin 
      • How to connect to a plugin engine
    • Explanations
      • What is a plugin engine
    • Link to a plugin store
  • Plugin development
    • Tutorial
      • I2k tutorial
    • How-tos guides
      • How to create a plugin
      • How to debug a plugin
      • How to upload plugin to github
      • How to create shareable urls
      • How to make your own plugin store
      • How to set up high-quality plugin projects (link to project templates, including Contributor instructions for the plugin itself, Unit tests with CI, code formatting, linting etc.)
      • How to edit Python plugin code in standalone editor with code highlighting by having the majority of code in a separate module and just a small import of that module in the plugin file.
    • Explanations
      • Sandboxes and RPC
    • API reference (standalone page)
  • Core development
    • How-tos guides
      • How to contribute
      • How to setup a dev environment
    • Explanations
      • Explain the repos
      • RPC
    • API reference (standalone page)
      • Imjoy-core
      • Imjoy-rpc
  • Changelog
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant