Update docs - Githubissues

BICCN / cell-locator

manually align specimens to annotated 3D spaces

https://cell-locator.readthedocs.io

Other

19 stars 7 forks source link

Update docs #225

Closed jcfr closed 1 year ago

jcfr commented 1 year ago

New

Add "Getting Started / Using Cell Locator" section
Add "Application Overview" section with following sub-sections:
- Atlas Selection
- User Interface
  - Lifecycle
  - Annotation List
  - Interaction Modes
  - 2D Viewer
  - 3D Viewer
  - Property Editor
  - Status Bar
Add reference to "Annotation File Version Changlist"

Updates

Update "Command Line Tools" to explicitly reference "cl-convert-api.md"
Improve "Annotation File Format" including links and using warning directive
Fix "Keyboard and Mouse Shortcuts" to document annotation visibility
Fix "Keyboard and Mouse Shortcuts" to account for multi-annotation support
Set "Getting Started" section as the first one
Update BUILD instructions