Skip to content

Restructure edit section in GUI guide - #1

Merged
anna-teruel merged 1 commit into
anna-teruel:userguidefrom
neuroinformatics-unit:userguide
Oct 9, 2026
Merged

anna-teruel merged 1 commit into
anna-teruel:userguidefrom
neuroinformatics-unit:userguide

Conversation

@lochhh

@lochhh lochhh commented Oct 9, 2026

Copy link
Copy Markdown

This PR attempts at an "extendable" structure to make it easier for us to document new edit types with the expected behaviour/consequences.

Summary of changes:

  • creates new section labels (e.g. (target-points-layer)=, (target-load-tracked-data)=) to refer to sections within the same doc
  • introduces the GUI elements involved in editing (viewer, Edit tracked data menu, edit timeline, Save tracked data menu) up front, before any steps
  • splits the old "Move and remove keypoints" steps into Select keypoints (common to all edits) and Edit types, with one subsection per edit type (currently Move and Remove); new edit types (e.g. add keypoints, swap keypoint labels, swap identities) can be added as further subsections
  • states behaviour common to all edits (menu expands, timeline appears, tracks layer stays in sync) once in the Edit types intro - no need to repeat per edit type
  • folds "Resume an editing session" into Save edits, and replaces the "Using edited data in Python" dropdown with a short tip linking to the netCDF section of the I/O guide
  • tries to keep the wording future-proof where features are expected to grow
  • corrects details against the implementation: transposing the viewer does not disable editing (only moving time off the frame slider or switching to 3D does); the timeline spans all frames of the dataset rather than the "recording"; edited is False (not NaN) for unedited keypoints
  • turns the bboxes limitation into a warning and moves it next to the intro
  • renames "Load the tracked dataset" to "Load tracked data" to match the menu name
  • removes the GIFs that no longer match the new structure and leaves <!-- TODO --> placeholders describing the GIFs/screenshots still needed

@anna-teruel anna-teruel left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All changes look good to me! Thank you @lochhh for taking the time to review my text. Appreciate it. I will merge this PR with my PR push it to #1126

@anna-teruel
anna-teruel merged commit 84aeb26 into anna-teruel:userguide Oct 9, 2026
@anna-teruel
anna-teruel deleted the userguide branch October 9, 2026 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants