docs: add challenge files template#1244

Merged

ojeytonwilliams merged 21 commits intofreeCodeCamp:mainfrom

majestic-owl448:docs/challenge-md-templates

Mar 13, 2026

Contributor

majestic-owl448 commented Mar 11, 2026

Checklist:

I have read freeCodeCamp's contribution guidelines.
My pull request has a descriptive title (not a vague title like Update index.md)

Related to #1200

This one aims to make some clarity on the general shape of the challenges, and which challengeType can be used for what

majestic-owl448 added 3 commits

March 11, 2026 21:10


          docs: add MD file templates to workshops, labs, quizzes, and reviews …

a0d62a8

…guides


          docs: add demoType to workshop step template

6ccb4df


          docs: clarify demoType is only for HTML-based challenges with demo

33fc755

majestic-owl448 requested a review from a team as a code owner

March 11, 2026 20:45

majestic-owl448 changed the title ~~Docs/challenge md templates~~ docs: add challenge files template

majestic-owl448 marked this pull request as draft

March 11, 2026 20:45

Contributor Author

majestic-owl448 commented Mar 11, 2026

I forgot about the hooks, adding those too

majestic-owl448 added 4 commits

March 12, 2026 10:21


          docs: add hooks section to labs and workshops guides

c8562ea

Documents --before-all--, --before-each--, --after-each--, and --after-all--
hooks: which challengeTypes support them, execution order, and how DOM
challenges (iframe) differ from non-DOM challenges (Web Worker).


          docs: clarify hook execution order and DOM vs non-DOM differences

2ebea48


          docs: clean up hooks execution order section

07db53d


          docs: fix fcc-editable-region markers mangled by prettier

5d52088

majestic-owl448 marked this pull request as ready for review

March 12, 2026 09:41

Jeevankumar-s requested changes

View reviewed changes

src/content/docs/how-to-work-on-workshops.mdx Show resolved Hide resolved

src/content/docs/how-to-work-on-workshops.mdx Outdated Show resolved Hide resolved

src/content/docs/how-to-work-on-workshops.mdx Outdated Show resolved Hide resolved

majestic-owl448 commented

View reviewed changes

src/content/docs/how-to-work-on-workshops.mdx Outdated Show resolved Hide resolved

majestic-owl448 commented

View reviewed changes

src/content/docs/how-to-work-on-workshops.mdx Outdated Show resolved Hide resolved


          Apply suggestions from code review

764b382

Co-authored-by: Jeevankumar S <jeevenkumar2003@gmail.com>

majestic-owl448 commented

View reviewed changes

src/content/docs/how-to-work-on-labs.mdx Outdated Show resolved Hide resolved

majestic-owl448 commented

View reviewed changes

src/content/docs/how-to-work-on-labs.mdx Outdated Show resolved Hide resolved


          Apply suggestions from code review

d616511

majestic-owl448 commented

View reviewed changes

src/content/docs/how-to-work-on-workshops.mdx Outdated Show resolved Hide resolved

majestic-owl448 commented

View reviewed changes

src/content/docs/how-to-work-on-labs.mdx Outdated Show resolved Hide resolved

majestic-owl448 and others added 2 commits

March 12, 2026 16:28


          Apply suggestions from code review

fb7995f


          style: fix trailing whitespace flagged by prettier

0e08006

majestic-owl448 commented

View reviewed changes

src/content/docs/how-to-work-on-workshops.mdx Outdated Show resolved Hide resolved


          Apply suggestions from code review

862c7fb

ojeytonwilliams requested changes

View reviewed changes

Contributor

ojeytonwilliams left a comment

Thanks for creating this, @majestic-owl448 I'm sure this will be very helpful.

src/content/docs/how-to-work-on-labs.mdx Outdated Show resolved Hide resolved

src/content/docs/how-to-work-on-workshops.mdx Outdated Show resolved Hide resolved

src/content/docs/how-to-work-on-workshops.mdx Show resolved Hide resolved

majestic-owl448 added 3 commits

March 13, 2026 10:09


          address review comments

5ce4b9d


          move execution order to shared partial and genericize language

dad1a8b


          docs: add Proposing a Pull Request section to labs guide

2f8cac8

Jeevankumar-s reviewed

View reviewed changes

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


          docs: add HTML/CSS/JS multi-file interactive editor example to review…

e60fc4e

…s guide

majestic-owl448 commented

View reviewed changes

src/content/docs/how-to-work-on-reviews.mdx Outdated Show resolved Hide resolved


          Apply suggestions from code review

66bbe4e

majestic-owl448 commented

View reviewed changes

src/content/docs/how-to-work-on-reviews.mdx Outdated Show resolved Hide resolved


          Apply suggestions from code review

40e4bab

majestic-owl448 requested review from Jeevankumar-s and ojeytonwilliams

March 13, 2026 09:52

majestic-owl448 mentioned this pull request

Add theory lesson docs #1247

Open

Jeevankumar-s approved these changes

View reviewed changes

Member

Jeevankumar-s left a comment

LGTM 🚀


          docs: clarify before-all scoping in non-DOM challenges

5e980d3

Variables declared in --before-all-- are not in scope during isolated
tests. State must be assigned to globalThis to persist across tests.

ojeytonwilliams approved these changes

View reviewed changes

Contributor

ojeytonwilliams left a comment

Just some nitpicks, overall this looks great 👍

src/content/docs/_hooks-shared.mdx Outdated Show resolved Hide resolved

src/content/docs/_hooks-shared.mdx Outdated Show resolved Hide resolved

majestic-owl448 and others added 2 commits

March 13, 2026 17:25


          Apply suggestions from code review

529d790

Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>


          fix: remove trailing whitespace in hooks-shared

82f51df

ojeytonwilliams merged commit 1ad4530 into freeCodeCamp:main

4 checks passed

majestic-owl448 deleted the docs/challenge-md-templates branch

March 13, 2026 16:49

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

Labels

None yet