From 67f59140671039404aa7bd8253a3e2e2a621a5b7 Mon Sep 17 00:00:00 2001 From: Daniel Trowbridge Date: Mon, 24 Feb 2025 17:16:40 +0000 Subject: [PATCH] Add page for using the response area template --- docs/advanced/response_areas/create.md | 35 +++++++++++++++++++++++++ docs/advanced/response_areas/sandbox.md | 1 + mkdocs.yml | 2 ++ 3 files changed, 38 insertions(+) create mode 100644 docs/advanced/response_areas/create.md create mode 100644 docs/advanced/response_areas/sandbox.md diff --git a/docs/advanced/response_areas/create.md b/docs/advanced/response_areas/create.md new file mode 100644 index 00000000..88f5b3d3 --- /dev/null +++ b/docs/advanced/response_areas/create.md @@ -0,0 +1,35 @@ +# Create a New Response Area + +The +[`response-area-template`](https://github.com/lambda-feedback/response-area-template) +repository provides a pre-configured base for developing a new response +area. The template includes the [sandbox](sandbox.md) development tool which you +can use to view and test your response area. + +## Prerequisites + +You should be familiar with [Git](https://git-scm.com/), +[TypeScript](https://www.typescriptlang.org) and [React](https://react.dev). + +## Implement your Response Area + +1. [Create a new repository](https://github.com/new?template_name=response-area-template&template_owner=lambda-feedback) + based on the template and clone it to your development machine. + +1. Start the sandbox: + ``` + $ ./start_sandbox + ``` + +1. Implement your response area by editing the following files: + + - `components/Input.component.tsx` + + This React component should enable a student to enter their response. + + - `components/Wizard.component.tsx` + + This React component should allow a teacher to configure the response + area. + +1. Commit and push your changes to your repository on GitHub. diff --git a/docs/advanced/response_areas/sandbox.md b/docs/advanced/response_areas/sandbox.md new file mode 100644 index 00000000..bc158935 --- /dev/null +++ b/docs/advanced/response_areas/sandbox.md @@ -0,0 +1 @@ +# Response Area Sandbox diff --git a/mkdocs.yml b/mkdocs.yml index 17e895b3..f5ca52b0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -62,6 +62,8 @@ nav: - "advanced/index.md" - Response Areas: - Overview: "advanced/response_areas/overview.md" + - Create a New Response Area: "advanced/response_areas/create.md" + - Response Area Sandbox: "advanced/response_areas/sandbox.md" - Evaluation Functions: - Quickstart Guide: "advanced/evaluation_functions/quickstart.md" - General Specification: "advanced/evaluation_functions/specification.md"