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

Surface Neuroglancer Documentation in the Portal UI and docsite #1383

Open
dgmccart opened this issue Dec 6, 2024 · 6 comments
Open

Surface Neuroglancer Documentation in the Portal UI and docsite #1383

dgmccart opened this issue Dec 6, 2024 · 6 comments
Assignees
Labels
Design requests specific to design doc site build engineering implementation specific to the portal doc site frontend

Comments

@dgmccart
Copy link
Collaborator

dgmccart commented Dec 6, 2024

We'd like to make the Neuroglancer Quickstart guide more discoverable both in the Portal UI and on the doc site to address the UXR finding that most of our users are unfamiliar with using Neuroglancer.

The Neuroglancer Quickstart documentation is not currently linked to in the Portal UI. @Janeece is there an SDS pattern you'd recommend for this? Linking on or near the View Tomogram buttons would be ideal.

The Neuroglancer Quickstart documentation is located under About the CryoET Data Portal section on the docsite. Renaming that section or moving the Neuroglancer Quickstart to the Tutorials Section are 2 suggestions.

@dgmccart dgmccart added frontend Design requests specific to design doc site build engineering implementation specific to the portal doc site labels Dec 6, 2024
@kandarpksk
Copy link
Collaborator

Another recommendation that can be rolled into this design is informing users that viewing the tomo also shows annotations (if we think both pieces of info should be in the same place).

@Janeece
Copy link
Collaborator

Janeece commented Dec 6, 2024

@dgmccart there isnt a specific SDS component/pattern per se — it would require design work to suggest a solution. Is there a timeline this addition is needed by?

@kandarpksk do you mean this design?
Screenshot 2024-12-06 at 11 08 58 AM

I'm not sure this is still being implemented? We could use this location, but it would only last until we implement table-level search & we'd have to consider other conflicts (like deposition state callout).

@dgmccart
Copy link
Collaborator Author

dgmccart commented Dec 6, 2024

I believe we opted not to implement the above design because all annotations are loaded into Neuroglancer by default. Some of the annotation layers may be turned off if they occlude other annotations, but they can be switched on just by clicking any layers with strikethrough text.

@junxini can comment on priority / timeline.

@junxini
Copy link
Contributor

junxini commented Dec 7, 2024

I believe we opted not to implement the above design because all annotations are loaded into Neuroglancer by default. Some of the annotation layers may be turned off if they occlude other annotations, but they can be switched on just by clicking any layers with strikethrough text.

i believe this is accurate

@junxini can comment on priority / timeline.

let's group this into the UXR recommendation implementation for Q1 @kandarpksk let me know if that works with you

@junxini
Copy link
Contributor

junxini commented Dec 7, 2024

The Neuroglancer Quickstart documentation is located under About the CryoET Data Portal section on the docsite. Renaming that section or moving the Neuroglancer Quickstart to the Tutorials Section are 2 suggestions.

We can proceed with this and wouldn't need to wait until Q1 if bandwidth allows. I think it would make sense for it to be under the tutorials section. Open to other suggestions @dgmccart

@dgmccart
Copy link
Collaborator Author

dgmccart commented Dec 9, 2024

Sounds good. Re: moving Neuroglancer Quickstart to Tutorials @melissawm will address that this quarter tracked in #1387

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Design requests specific to design doc site build engineering implementation specific to the portal doc site frontend
Projects
None yet
Development

No branches or pull requests

5 participants