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

Create documentation page in the wiki #207

Open
fedorov opened this issue May 9, 2024 · 1 comment
Open

Create documentation page in the wiki #207

fedorov opened this issue May 9, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@fedorov
Copy link
Member

fedorov commented May 9, 2024

For now, we will use a single-page documentation to cover most important features, and will add content to that page as needed.

We should include the following:

  • configuration to use external server and how to enable the "link" icon in the UI (follow up on Configurable servers #5)
  • ...
@fedorov fedorov added the documentation Improvements or additions to documentation label May 9, 2024
@igoroctaviano
Copy link
Collaborator

igoroctaviano commented May 10, 2024

@pedrokohler

  • Add a new section showing how to enable the tool that allows the user to change the main data source on the fly
  • Add a new section showing how to use the gcp query param as a secondary data source to retrieve annotations or derived datasetets
  • Add a new section showing how to customize the highlight color of annotations and how to change the color of each annotation (this would require some investigation to see how this works, you can find examples in the public folder)
  • Add a new section showing how to disable all annotations (read only mode): disableAnnotationTools property and how to disable worklist (disableWorklist property)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants