Skip to content

Add documentation for creating new response areas #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all 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
35 changes: 35 additions & 0 deletions docs/advanced/response_areas/create.md
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions docs/advanced/response_areas/sandbox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Response Area Sandbox
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Loading