Skip to content

Docs#13

Open
m-messer wants to merge 5 commits into
mainfrom
docs
Open

Docs#13
m-messer wants to merge 5 commits into
mainfrom
docs

Conversation

@m-messer
Copy link
Copy Markdown
Member

Updated the README to be more user-friendly. We can then point the user documentation to this repo, which will serve as the primary source for the response area sandbox.

Addresses points in: https://trello.com/c/yJag8OXG/1043-ra-sandbox-docs

@m-messer
Copy link
Copy Markdown
Member Author

Updated to add a purpose statement and how the sandbox works. Additionally, added comments from the SEG students.

@timothee-alby timothee-alby removed their assignment May 18, 2026
Copy link
Copy Markdown
Member

@peterbjohnson peterbjohnson left a comment

Choose a reason for hiding this comment

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

I've left a couple of online comments. They're minor but I suggest follow them.

This looks great, thanks . Let's see what people make of it!

Comment thread README.md
Comment on lines 83 to 86
```
npm install --global yarn
yarn
```
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Apparently the following is a more modern approach:

corepack enable
yarn install

Comment thread README.md

**a) Copy the Sandbox folder**

Duplicate the folder `src/types/Sandbox/` and rename the copy after your type (e.g. `src/types/<YourType>/`). This is your starting point — all your code will live here.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

'All your code will live here' - is this worth emphasising? I.e. to create a RA that can be deployed on production, ensure that all your code is only in this folder?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants