Skip to content

Commit

Permalink
image batch 2
Browse files Browse the repository at this point in the history
  • Loading branch information
ganicke committed Aug 16, 2024
1 parent b4036e7 commit 7bc6e6c
Show file tree
Hide file tree
Showing 10 changed files with 40 additions and 54 deletions.
Binary file added docs/static/teachertool/autorun-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/teachertool/checklist-execution.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/teachertool/edit-outcome-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/teachertool/edit-outcome-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/teachertool/editing-results-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/teachertool/editing-results-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/teachertool/editing-results-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/teachertool/prebuilt-rubrics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/teachertool/run-checklist-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
94 changes: 40 additions & 54 deletions docs/teachertool.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,96 +63,82 @@ User can fill in parameters:
![Project validation](/static/teachertool/validate-me.png)

7. With a project loaded, user can run the checklist and see results by clicking the "Run" button
- Button is disabled without loaded project

![image](https://github.com/microsoft/pxt-microbit/assets/69657545/d4a2eb67-0939-46e9-9294-3b8a6acdf560)
- Button is disabled without loaded project

![image](https://github.com/microsoft/pxt-microbit/assets/69657545/1086249b-9dae-479b-8a6e-60901dbd06fd)
![Run checklist](/static/teachertool/run-checklist-button.png)

![Checklist execution](/static/teachertool/checklist-execution.png)

### Editing Results

1. User can add feedback/notes using the "Add Notes" button
- The feedback box should resize to fit its content
- Feedback is persisted if the user re-runs the rules using the "Run" button
- <details>
<summary>Screenshots</summary>
![image](https://github.com/microsoft/pxt-microbit/assets/69657545/b79d44ef-b326-48c7-b3b5-9e24e3d3f632)
![image](https://github.com/microsoft/pxt-microbit/assets/69657545/f07b6d4c-4ff5-46d3-9256-7c2eb2585032)
![image](https://github.com/microsoft/pxt-microbit/assets/69657545/a7d2211a-d4b3-4bf8-b913-2aa820c62060)

</details>
- The feedback box should resize to fit its content
- Feedback is persisted if the user re-runs the rules using the "Run" button

![Editing results](/static/teachertool/editing-results-1.png)

![Editing results](/static/teachertool/editing-results-2.png)

![Editing results](/static/teachertool/editing-results-3.png)

4. User can edit an outcome using the provided dropdown
- <details>
<summary>Screenshots</summary>

![image](https://github.com/microsoft/pxt-microbit/assets/69657545/fcf045db-a6e1-47be-84ff-b11ced6d25da)
![image](https://github.com/microsoft/pxt-microbit/assets/69657545/c8b7bc02-2183-4b7d-8626-e2e8e2019d7a)

</details>
![Edit outcome](/static/teachertool/edit-outcome-1.png)

![Edit outcome](/static/teachertool/edit-outcome-2.png)

### Result Clearing and Auto-Run

1. If auto-run is **disabled**, a result's outcome (i.e. "Looks good", "Needs work", etc...) should be set to "Not started" automatically when any of any of the following conditions are met:
- It is newly added (should default to the "Not Started" state)
- A parameter in a rule is changed (only the affected rule should enter the "Not Started" state)
- The loaded project changes (all rules should be set to "Not started")

- It is newly added (should default to the "Not Started" state)
- A parameter in a rule is changed (only the affected rule should enter the "Not Started" state)
- The loaded project changes (all rules should be set to "Not started")

2. Auto-run can be toggled on/off using the button in the menu.
- <details>
<summary>Screenshots</summary>

![image](https://github.com/microsoft/pxt-microbit/assets/69657545/6a240966-e01c-4d1a-984d-38942bac5ede)
![Auto-run button](/static/teachertool/autorun-button.png)

</details>
3. If auto-run is **enabled**, any rules that enter the "Not started" state from the above conditions should immediately and automatically get re-run and have their results updated.

### Loading/Importing/Exporting Checklists

1. User can open pre-built rubrics from the home page
- Will ask for overwrite confirmation if the user already has an in-progress checklist.
- <details>
<summary>Screenshots</summary>

- Will ask for overwrite confirmation if the user already has an in-progress checklist.

![image](https://github.com/microsoft/pxt-microbit/assets/69657545/f5362525-55f6-4823-82f5-4a9e237c9b06)
![Pre-built rubrics](/static/teachertool/prebuilt-rubrics.png)

</details>
2. User can export a checklist from the vertical "..." menu near the "auto-run" button. This will download a json file.
- <details>
<summary>Screenshots</summary>

![image](https://github.com/microsoft/pxt-microbit/assets/69657545/7718d1f3-1f17-4750-851a-41e24021f156)
![image](https://github.com/microsoft/pxt-microbit/assets/69657545/517838b7-27e9-4f60-bf17-8d720c179537)
![image](https://github.com/microsoft/pxt-microbit/assets/69657545/7718d1f3-1f17-4750-851a-41e24021f156)

![image](https://github.com/microsoft/pxt-microbit/assets/69657545/517838b7-27e9-4f60-bf17-8d720c179537)

</details>
3. User can import a rubric from a file using the same "..." menu, or from the card on the welcome page.
- Rubric file can be selected via "Browse" or dropped directly into the popup
- Will ask for overwrite confirmation if the user already has an in-progress checklist.
- <details>
<summary>Screenshots</summary>

- Rubric file can be selected via "Browse" or dropped directly into the popup
- Will ask for overwrite confirmation if the user already has an in-progress checklist.

![image](https://github.com/microsoft/pxt-microbit/assets/69657545/f016b728-9165-4717-a7de-c9e496208602)
![image](https://github.com/microsoft/pxt-microbit/assets/69657545/61c94e3c-d9b2-4dfc-90a2-696139da3e20)
![image](https://github.com/microsoft/pxt-microbit/assets/69657545/4b33a8cc-0f33-411c-8bf4-144e3d72933d)
![image](https://github.com/microsoft/pxt-microbit/assets/69657545/35a76e51-4600-4c07-a72c-8b631aa7959f)
![image](https://github.com/microsoft/pxt-microbit/assets/69657545/f016b728-9165-4717-a7de-c9e496208602)

</details>
![image](https://github.com/microsoft/pxt-microbit/assets/69657545/61c94e3c-d9b2-4dfc-90a2-696139da3e20)

![image](https://github.com/microsoft/pxt-microbit/assets/69657545/4b33a8cc-0f33-411c-8bf4-144e3d72933d)

![image](https://github.com/microsoft/pxt-microbit/assets/69657545/35a76e51-4600-4c07-a72c-8b631aa7959f)

### Other

- If user refreshes the page (or closes/re-opens the browser), their checklist should be preserved.
- User can click the print button to create a version of the results with the outcome and feedback visible, but other UI elements hidden (currently broken).
- <details>
<summary>Screenshots</summary>

![image](https://github.com/microsoft/pxt-microbit/assets/69657545/ba576cb1-94d3-4f44-b513-b8c389fb9a30)
![image](https://github.com/microsoft/pxt-microbit/assets/69657545/ba576cb1-94d3-4f44-b513-b8c389fb9a30)

</details>
- The checklist-view/project-view splitter can be resized. It can also be reset to 50/50 split with double-click.
- <details>
<summary>Screenshots</summary>
![image](https://github.com/microsoft/pxt-microbit/assets/69657545/7954c412-6e16-4280-b205-f887c0cebbe9)
![image](https://github.com/microsoft/pxt-microbit/assets/69657545/42194fcc-6413-4b35-8c7b-fcfb506e99da)

</details>
![image](https://github.com/microsoft/pxt-microbit/assets/69657545/7954c412-6e16-4280-b205-f887c0cebbe9)

![image](https://github.com/microsoft/pxt-microbit/assets/69657545/42194fcc-6413-4b35-8c7b-fcfb506e99da)

0 comments on commit 7bc6e6c

Please sign in to comment.