From 9b2618a6280ec6bd0ed2240ab64843d7c805cfb8 Mon Sep 17 00:00:00 2001 From: Pasindu Fernando <116358471+Pasindufdo98@users.noreply.github.com> Date: Sun, 18 May 2025 15:03:35 +1000 Subject: [PATCH] docs: add unit-details-editor component review documentation --- .../Migration/task_unit-details-editor.md | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 docs/OnTrack/Front End Migration/Migration/task_unit-details-editor.md diff --git a/docs/OnTrack/Front End Migration/Migration/task_unit-details-editor.md b/docs/OnTrack/Front End Migration/Migration/task_unit-details-editor.md new file mode 100644 index 000000000..b8815edbf --- /dev/null +++ b/docs/OnTrack/Front End Migration/Migration/task_unit-details-editor.md @@ -0,0 +1,39 @@ +# OnTrack Component Review + +## Team Member Name +**Pasindu Fernando** +**Student ID:** s224263102 + +## Component Name +**unit-details-editor** + +## Files in this Component +- `unit-details-editor.coffee` +- `unit-details-editor.tpl.html` + +## Component Purpose +The unit-details-editor component allows an administrator or convenor to view and update the core details of a unit, such as code, name, description, teaching period, key dates, and system behaviors. It also includes toggles for configuration options like student extensions, tutorial editing rights, D2L integration, and Overseer assessment. + +This interface is essential for managing how a unit behaves in OnTrack, setting parameters that influence student interaction, task generation, and system automation. + +--- + +## Component Outcomes and Interactions + +### **Expected Outcome** +- Unit details can be viewed and edited in a form layout. +- Dropdowns are available for selecting the teaching period and learning summary task. +- Staff can choose dates using date pickers for start, end, and portfolio auto-generation. +- Toggle options let users enable or disable settings like extension requests and notifications. +- When the "Update" button is clicked, the changes should be saved and success feedback should appear. + +--- + +## Inputs +- Users interact with the form fields to modify this data. + +--- + +## Outputs +- Updates are saved through the API when the "Update" button is pressed. +- Visual feedback is shown on success or error.