Skip to content

docs: add guide for working on theory lessons#1259

Open
majestic-owl448 wants to merge 2 commits intofreeCodeCamp:mainfrom
majestic-owl448:docs/theory-lessons
Open

docs: add guide for working on theory lessons#1259
majestic-owl448 wants to merge 2 commits intofreeCodeCamp:mainfrom
majestic-owl448:docs/theory-lessons

Conversation

@majestic-owl448
Copy link
Contributor

@majestic-owl448 majestic-owl448 commented Mar 17, 2026

Checklist:

Closes #1247

Adds a new guide page for working on theory lessons (challengeType 19), including:

  • File templates for both # --interactive-- and # --description-- variants
  • Metadata requirements (blockLabel: lecture, blockLayout: challenge-list, dashedName starting with lecture-)
  • Instructions for creating a theory lesson with pnpm run create-new-project
  • Documentation for the create-next-challenge, insert-challenge, and delete-challenge scripts
  • Writing lesson content: static code blocks and all :::interactive_editor combinations (JS-only, HTML-only, HTML+CSS, HTML+JS DOM, HTML+CSS+JS)
  • Writing questions structure (--text--, --answers--, --feedback--, --video-solution--)

Paired with #1260 which updates the labs, quizzes, and reviews guides with similar metadata and creation workflow documentation.

Copy link
Contributor

@jdwilkin4 jdwilkin4 left a comment

Choose a reason for hiding this comment

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

Looks good.
Left one comment

<questions>
```

## Writing Lesson Content
Copy link
Contributor

Choose a reason for hiding this comment

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

We should make it clear who write lesson content.
Right now we have it set to just staff because we don't want a bunch of AI slop.
So we should add some sort of note here about that. The note can also mention if contributors have an idea for a new lesson, they should propose an issue first so the curriculum team can triage it.

We should also mention the review process for lessons too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

what do you think should be mentioned in the review process?

Copy link
Contributor

Choose a reason for hiding this comment

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

The author writes the lesson in hashnode, then pings Kris or myself for review. We review it and then it is added to main.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ah, you mean that! yes, sure, I will add that! I was thinking about the PR review

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.

Add theory lesson docs

2 participants