Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/teacher/guides/analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,17 @@
## Module-level analytics

The module overview tab displays cohort progress and cohort activity. Access to the overview tab is subject to teacher role privileges.
![Module Overview](images/Module_Stats.png)

The Content tab displays all Sets, with cohort-level data on activity and progress within each Set. Access to the data within the Content tab is subject to teacher role privileges.
![Set Overview](images/Set_Stats.png)

Within the content there is a stats tab which shows cohort-level data on question completion and statistics on time spent on each question. Response Areas are listed and show completion rates overall, and best per student. Detailed response statistics are available in the 'Explore' button on the Response area. The stats tab availability is subject to teacher role privileges.

The ID of Response Areas is linked between module instances. If a Response Area maintains the response data shape then the data across multiple instances can be combined for stronger statistics. As of 10/7/25 there are no features in the UI to link data across instances, but these links will be added in future (the data saved is in the correct structure to allow this feature on all past data).

![Detailed Set Stats](images/Detailed_Set_Stats.png)

## Analytics and question versions

Analytics begin when a question is _published_. After publishing a question for the first time it becomes available to students and their usage is logged and fed back to the student and the teacher.
Expand Down
4 changes: 0 additions & 4 deletions docs/teacher/guides/good-practice.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,6 @@ Usage examples:

![gif showing the branching feature](images/branching.gif)

### Audio clips

Drag + drop an audio file into the editor, or record audio on the 'Insert v' drowpdown in Lexdown.

### Input symbols

Input symbols help in two ways:
Expand Down
24 changes: 24 additions & 0 deletions docs/teacher/guides/guidance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Guidance

Guidance provides a summary of the task, it's difficulty and the estimated time.
Guidance is provided at the question level, and can be set to each question in the set.

## Editing Guidance
To edit the question guidance, click the "Edit Guidance" button at the top of the page.

Here you can enter four parts:
1. Guidance Blurb - The short description of the question.
2. Minimum Time Estimate - The least amount of time the task should take in minutes.
3. Maximum Time Estimate - The longest amount of time the task should take in minutes.
4. Skill - The difficulty of the task, rated out of three stars.

### Obtaining Guidance Time

We also support suggesting the time estimate. This uses machine learning based on worked solution and skill level to determine an estimated time for the task.

To use this feature do the following:
1. Fill in all the question's attributes as much as possible. i.e, the question's text, the worked solution, skill level etc., The more information is filled in, the more accurate the suggested guidance time will be.

2. Click on the "Suggest" button in the guidance configuration tab after you have filled in all the question's attributes.

![Suggest Button](images/guidance-time-suggestion.png)
9 changes: 0 additions & 9 deletions docs/teacher/guides/guidance/guidance-time-suggestion.md

This file was deleted.

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/teacher/guides/images/Module_Stats.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/teacher/guides/images/Set_Stats.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 8 additions & 4 deletions docs/teacher/guides/lexdown.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# The lexdown editor
# The content editor

The lexdown is widely used in Lambda Feedback. It accepts:
The content editor is widely used in Lambda Feedback. It accepts:

- standard [markdown](https://www.markdownguide.org/basic-syntax/)
- [$\LaTeX$](https://www.overleaf.com/learn/latex/Learn_LaTeX_in_30_minutes) (delimited by $ and limited to [KaTeX](https://www.katex.org) functionality)
- images (paste or drag and drop)
- videos (paste a URL)

The lexdown editor is an adapted version of lexical to use markdown-first, and incorporate features including drag-and-drop images, embedded videos and autio, and switch to raw markdown.
The content editor is an adapted version of lexical to use markdown-first, and incorporate features including drag-and-drop images, embedded videos and audio, and switch to raw markdown.

## Common needs in Lexdown
## Common needs in the content editor

Here's a walkthrough to create some basic content:

Expand Down Expand Up @@ -59,6 +59,10 @@ This is the process to create the solution steps:

You can add images with drag-and-drop or copy-and-paste. Images can be resized with the mouse, or click on the image to configure, or edit the raw markdown.

### Audio clips

Drag + drop an audio file into the editor, or record audio on the 'Insert v' drowpdown in Lexdown.

### Empty lines

Use 'Enter' for a new paragraph, or 'shift-Enter' for a line break.
10 changes: 10 additions & 0 deletions docs/teacher/reference/response_area_components/Boolean.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Boolean

This response area allows students to select True or False.

## Evaluation Function Options

### `isExactEqual`

Checks if the answer is exactly equal to the response. In this case if the response is True or False.
The `type` should be set to `bool`, to ensure boolean comparison.
15 changes: 15 additions & 0 deletions docs/teacher/reference/response_area_components/Code.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Code

This response area allows students to write code for a specified programming language.

## Evaluation Function Options

### `chatGPT (experimental)`
Copy link
Contributor

Choose a reason for hiding this comment

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

We shouldn't include information about evaluation functions in the docs. That should be pulled automatically from the function repositories, or link to the GitHub repo. This avoids duplication and outdated info.


Passes the student's response and a teacher written prompt to GPT for evaluation.


### `compareContsructs (experimental)`
Python Only. Compares console output to a teacher's provided answer and comparing the structure of the teacher's solution to the student provided responses.
Student functions can also be ran against a set of teacher provided unit tests, if these fails, feedback can be generated by GPT if enabled.
It also provides feedback on syntax and style.
12 changes: 12 additions & 0 deletions docs/teacher/reference/response_area_components/Essay.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Essay

Similar to [!Text](Text.md), allows student's to enter any text input, whether that be prose, math, code or any other type of input, but in a longer format.

## Evaluation Function Options

As text supports any input, so most evaluation functions can be used.
However, there are some text specific evaluation functions, such as shortTextAnswer and chatGPT.

### `chatGPT (experimental)`

Passes the student's response and a teacher written prompt to GPT for evaluation.
7 changes: 7 additions & 0 deletions docs/teacher/reference/response_area_components/Likert.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Likert

Allows students to fill in a five point Likert (Strongly Disagree to Strongly Agree) for any number of statements.

## Evaluation Function Options

Currently, there is no supported evaluation functions for this response area.
7 changes: 7 additions & 0 deletions docs/teacher/reference/response_area_components/Milkdown.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Milkdown

Similar to [!Essay](Essay.md), allows student's to enter any text input, but with standard Markdown processing, including headers, bullet points, numbers, table, etc.

## Evaluation Function Options

Currently, there is no supported evaluation functions for this response area.
14 changes: 14 additions & 0 deletions docs/teacher/reference/response_area_components/Text.md
Original file line number Diff line number Diff line change
@@ -1 +1,15 @@
# Text

Allows student's to enter any text input, whether that be prose, math, code or any other type of input.

## Evaluation Function Options

As text supports any input, any evaluation function can be used.
However, there are some text specific evaluation functions, such as shortTextAnswer and chatGPT.

### `chatGPT (experimental)`

Passes the student's response and a teacher written prompt to GPT for evaluation.

### `shortTextAnswer (experimental)`
Uses natural language processing techniques to calculate the similarity between a student's response and a teacher's answer, using semantic similarity.
3 changes: 2 additions & 1 deletion docs/teacher/reference/response_area_components/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ This opens the **Response Area Panel**, separated into four tabs:
- Text (for short text answers)
- Table
- Multiple-choice
- Expression (gives a preview for the typed symbolic expression)
- MATH_SINGLE_LINE
- MATH_MULTI_LINE
- Numeric units (separate fields for a number and its units)
- Code
- Essay (for long text answers)
Expand Down