How to work on review pages
The reviews summarise the topics introduced in the corresponding chapter or module, in lectures and workshops (as some workshops introduce new concepts not taught in the lectures). Some modules could have more than one review depending on how they are structured.
The concepts in a review should follow this pattern.
- **some topic**: some explanation
```some code here if necessary```The topics can be divided in sections using headings, headings should start from h2 level.
## Topic
- **some topic**: some explanation
### Sub topic (if needed)The metadata for reviews require a blockLabel property with a value of review, and a blockLayout with a value of link.
Reviews use a challengeType of 31.
Reviews have a dashedName with review-topic, and titles of the reviews are like Topic Review.
Review File Template
Section titled “Review File Template”Each review is a single Markdown file. The content section uses either # --interactive-- or # --description-- depending on whether the review includes interactive code editors.
Use # --interactive-- when the review includes :::interactive_editor blocks that campers can run directly.
For JavaScript-only examples:
---id: <ObjectId>title: [Topic] ReviewchallengeType: 31dashedName: review-topic-name---
# --interactive--
## Section Heading
- **concept**: explanation
```js// optional static code example```
:::interactive_editor
```js// interactive code example campers can run```
:::
# --assignment--
Review the [topic] topics and concepts.For CSS and JS examples, include the HTML file inside the same :::interactive_editor block. The HTML file must explicitly link to the CSS and/or the JS files, they are not linked automatically:
:::interactive_editor
```html<link rel="stylesheet" href="styles.css" /><!-- HTML content --><script src="index.js"></script>```
```css/* CSS styles */```
```js// JavaScript code```
:::Use # --description-- when the review only contains static markdown content:
---id: <ObjectId>title: [Topic] ReviewchallengeType: 31dashedName: review-topic-name---
# --description--
## Section Heading
- **concept**: explanation
```bash# optional code example```
# --assignment--
Review the [topic] topics and concepts.