rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation of new calibration wizard structure

Browse source
This commit is contained in:
Julian Stirling 2025-10-23 10:18:28 +01:00
parent 7c0badb1af
commit 8e2cf2a5cd
3 changed files with 104 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

20
webapp/src/components/modalComponents/calibrationWizardComponents/calibrationWizardTask.vue
View file

@ -1,13 +1,23 @@
<!-- The base component for a wizard task.
Do not import this directly into CalibrationWizard as the list of steps and props
will be confusing.
A task should be used for higher level groupings of individual steps in the wizard,
such as calibrating a Thing.
such as calibrating a Thing. Tasks can be divided into multiple steps.
Tasks can be divided into multiple steps.
## How to use this component:
*To make a task with lots of steps:*
Create a task component for a `Thing`, that wraps just this component and passes in
a list of steps. See `cameraCalibrationTask.vue` and `cameraStageMappingTask.vue`
as examples.
*To make a simple task with just one step:*
See `singleStepTask.vue`. This is what is used to display the welcome task.
## How not to use this component:
Do not import this directly into CalibrationWizard as the list of tasks will then
also need props to be passed with the list of step components and step props, and it
gets very confusing.
-->
<template>
<div>