brain-bican / taxonomy-development-tools

Tools to build and edit Cell Annotation Schema taxonomies.
Apache License 2.0
3 stars 1 forks source link

Simplify actions menu #91

Closed dosumis closed 5 months ago

dosumis commented 6 months ago

Status: Draft

The current actions menu is long an confusing, especially to users who don't know GitHub workflows. We need 3-4 options, clearly documented.

  1. Save/commit/push (perhaps some split needed - we need to discuss)
  2. Publish (for the first time or a new version)
  3. Export to AnnData.

Associated issue - we need to think carefully about workflows for concurrent editing. Ideally save and commit means just save/commit (and push?) the underying nanobot tables not CAS JSON as the latter is not really diffable. Publish = publish JSON as a release artifact. Table should merge OK most of the time. We need to simulate what happens when they don't and think through how we will work with groups to resolve. Maybe place any CAS we need to write for other purposes on .GitIgnore?

Also - we need a strategy for .GitIgnore in general.

hkir-dev commented 6 months ago

Menus

Sync automatically on load.

To investigate - storing history to allow roll back. How feasible is it and how much work would be involved in implementation.

hkir-dev commented 5 months ago

Upon the completion of the code review, I saw that implementing a solution based on submenus would be faster, hence this method was utilized for the initial deployment.

Image

@dosumis @AvolaAmg I'd appreciate your feedback on whether this menu layout seems intuitive or if a separate menu for each action group would be more effective.

AvolaAmg commented 5 months ago

I think it is intuitive enough. Separate menus might become too dispersive.

hkir-dev commented 5 months ago

completed with https://github.com/brain-bican/taxonomy-development-tools/pull/127