MetaCell / MetaCell/nwb-explorer

Add docs/definitions of elements/metadata tags from NWB schema

Open
#91 0 comments 0 reactions 0 assignees View on GitHub
enhancement PRIORITY: Low
Dominant language
JavaScript
Stars
27
Forks
16
PR merge metrics
No merged PRs in 30d

Description

These YAML files define the structure of the elements of the NWB file: https://github.com/NeurodataWithoutBorders/nwb-schema/blob/dev/core/nwb.file.yaml#L111

It would be good to parse these and load the doc fields to add as hover over/tool tips on the corresponding element in the NWBE GUI, e.g. Experimenter, Stimulus, Device, etc....

A lot of the docs deal with how to structure an NWB file rather than just explaining what the field/group is used for (so developer documentation aot user documentation...), but it would be better than nothing for completely new users looking through the data...

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the NWB schema file core/nwb.file.yaml around the referenced definitions and review how its doc fields describe elements such as Experimenter, Stimulus, and Device. Then locate the NWBE GUI’s corresponding element views; done means those definitions are parsed and shown as hover text or tooltips for new users.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.