Skip to content

Create documentation page for NeuropixelsV2e GUI #41

@bparks13

Description

@bparks13

Currently there is no documentation for any dialogs created in the Design library.

First, we should create a page for the NeuropixelsV2e dialogs based on the format discussed in #37 to test how the format looks.

One aspect not discussed there, for all of the GUIs created so far there are nested layers to them, meaning that for NeuropixelsV2e specifically there is a dialog window for an individual probe configuration, which can be combined with a second probe configuration at the device level, which can then be combined with a NeuropixelsV2eBno055 dialog at the headstage level. Each level should be discussed, specifically how to access them (i.e., double-clicking the headstage node, selecting the ellipses next to the probe configuration variable, etc.). While the bulk of the work is done at the lowest level (probe configuration dialog), the major screenshot to discuss should be the headstage level to be the most comprehensive.

This page should include:

  • Screenshot of the GUI
    • This includes all levels
    • Screenshot should be saved in an easily editable form (see README for details) with sections highlighted for reference
  • Text describing each of the sections highlighted in the screenshot
  • Minimal GIFs, but if text is cumbersome to use or the action has a temporal component that benefits from a video format then use that
  • Links to relevant information already provided (e.g., enums for dropdown menus should be referenced, not written manually)
  • Minimal workflow that contains the nodes which have GUIs attached to them
    • Call the same workflow as the aggregate page

Metadata

Metadata

Assignees

Labels

improvementImprovements to existing docs

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions