Skip to content

Commit 20619ab

Browse files
docs: add create-new-project instructions to non-workshop docs
Closes #1181 - The create-new-project script is used for labs, quizzes, and reviews, not just workshops. Added documentation to: - how-to-work-on-labs.mdx - how-to-work-on-coding-challenges.mdx - how-to-work-on-quizzes.mdx - how-to-work-on-reviews.mdx
1 parent 28d224b commit 20619ab

4 files changed

Lines changed: 34 additions & 0 deletions

File tree

src/content/docs/how-to-work-on-coding-challenges.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -741,6 +741,10 @@ If you are working with the step-based challenges, refer to the [Work on Worksho
741741

742742
There are a few helper scripts that can be used to manage the challenges in a block. Note that these commands should all be run in the block directory. For example:
743743

744+
745+
### Create a New Project
746+
747+
Run `pnpm run create-new-project`. This opens up a command line UI that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/blocks/test-project`.
744748
```bash
745749
cd curriculum/challenges/english/blocks/basic-algorithm-scripting
746750
```

src/content/docs/how-to-work-on-labs.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,13 @@ For the labs that do not have a demo project, the solution can be the minimum ne
3535
The labs that have a demo project have a `demoType` property in the frontmatter with a value of `onClick`, the labs that do not have a demo project do not have a `demoType` project.
3636

3737
The metadata for labs require a `blockType` property with a value of `lab`, and a `blockLayout` with a value of `link`.
38+
39+
## Using the Scripts Manually
40+
41+
If you want to work on the challenges manually, in your local IDE, you can run the step management scripts directly.
42+
43+
The `tools/challenge-helper-scripts` folder contains tools to help facilitate the creation and maintenance of the freeCodeCamp project-based curriculum.
44+
45+
### Create a New Project
46+
47+
Run `pnpm run create-new-project`. This opens up a command line UI that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/blocks/test-project`.

src/content/docs/how-to-work-on-quizzes.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,3 +165,13 @@ Also, any question that was taken from external quiz sites is prohibited.
165165
Please come up with your own quiz questions and answers.
166166

167167
</Aside>
168+
169+
## Using the Scripts Manually
170+
171+
If you want to work on the challenges manually, in your local IDE, you can run the step management scripts directly.
172+
173+
The `tools/challenge-helper-scripts` folder contains tools to help facilitate the creation and maintenance of the freeCodeCamp project-based curriculum.
174+
175+
### Create a New Project
176+
177+
Run `pnpm run create-new-project`. This opens up a command line UI that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/blocks/test-project`.

src/content/docs/how-to-work-on-reviews.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,13 @@ The metadata for reviews require a `blockType` property with a value of `review`
3131
Reviews use a `challengeType` of 31.
3232

3333
Reviews have a dashedName with `review-topic`, and titles of the reviews are like `Topic Review`.
34+
35+
## Using the Scripts Manually
36+
37+
If you want to work on the challenges manually, in your local IDE, you can run the step management scripts directly.
38+
39+
The `tools/challenge-helper-scripts` folder contains tools to help facilitate the creation and maintenance of the freeCodeCamp project-based curriculum.
40+
41+
### Create a New Project
42+
43+
Run `pnpm run create-new-project`. This opens up a command line UI that guides you through the process. Once that has finished, there should be a new challenge in the English curriculum that you can use for the first step of the project. For example, if you created a project called `test-project` in the Responsive Web Design certification, it would be in `curriculum/challenges/english/blocks/test-project`.

0 commit comments

Comments
 (0)