Repository navigation
Clean up examples #7
Description
Activity
Next step is to make specific to-do items.
From discussion today...
- Delete examples that aren't very simple.
- Intend to initially maintain two examples...
- A basic declarative panel & menu item "Hello World" example.
- A computation example.
We may add more later. Examples should AI agent friendly.
Notes from backlog refinement:
Information should be added to the README such as How to make a plugin, referencing the cookiecutter repository for instructions on initializing a new plugin
This should be linked in the contributing page if it is not already.
API documentation – the plugins should be using the API, there should be links to the API documentation.
In the future we should add more explicit LLM rules/skillsNeed sub-issues for:
Deleting outdated existing examples.
Updating the README / referencing cookiecutter
Planning out what examples should be included in this repositoryPotential Pitfalls:
These examples should be kept simple and minimal but need to cover a wide number of uses, consideration on what is put here is important.
Each example will become a maintenance burden so adding too many or complex examples will increase this costNotes from discussion on 2026-09-17
Add PR to clean up non-useful examples
Then add additional PR’s for each example we want
In an example for ui – give minimal example and reference UI demo (in nion ui)
In examples demo things specific to swift – e.g. draggable data items as it is specific to swift and not covered in nionUI
This work should be done using copilot to make sure that copilot is capable of doing this
Suggested focus:
• Menu item
• Panel
Put all PR’s against issue 7Canvas panel example – out of date – delete
Interactive examples – stay – but could be updated (run script examples)
Menu example – very important – probably doesn’t need changing (could add typing)
Panel example – needs updating to use declarative
Random capture – uncertain – shows implementing a hardware source
ReadData – update and add nhdf
ScanAcquisistion – useful – may need updating (typing in particular)
Voices – DeleteAdditional:
Computation – not yet
Color tables – add a color table
Run script package- added a commit that references this issue
on Sep 24, 2026
