Skip to content

Enhance lesson content with pull request workflow details #559

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sstevens2 merged 1 commit into from
Jun 9, 2026
Merged

Enhance lesson content with pull request workflow details #559

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions episodes/lesson-content.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ as a bullet list in the `index.md` file of your lesson repository.
::::::::::::::::::::::::::::::::::::::::::::::::::

Below those, let's add the prerequisite skills you determined earlier for your lesson.
This time, instead of committing directly to the `main` branch - we will save our changes on another branch and then do a pull request to merge them to `main` that will allow us to review and spot any issues.

## Proposing Changes with Pull Requests

Expand Down Expand Up @@ -133,13 +134,6 @@ Since a more in-depth discussion of pull request reviews is included in the GitH

:::::::::::::::::::::::::::::::::::::::::::::::

Once the changes have been merged and your lesson site rebuilds, check how prerequisites block appears on your lesson's home page.
A screenshot below provides an example.

![A rendered lesson prerequisite fenced div](fig/prereq-fenced-div.png){
alt="Lesson prerequisite fenced div structural block as rendered in a Web page by the Workbench"
}

You will have an opportunity to practice this pull request workflow in a moment.

We just added the prequisites as a bullet point list in `index.md`, but the Workbench provides a special formatted block for lesson prerequisites, so they appear visually distinct on the page.
Expand All @@ -160,6 +154,12 @@ Finally, end your fenced div with a closing tag consisting of at least 3 colons
and we will explore most of them in this episode.
:::

A screenshot below provides an example of how prerequisites block appears in a webpage.

![A rendered lesson prerequisite fenced div](fig/prereq-fenced-div.png){
alt="Lesson prerequisite fenced div structural block as rendered in a Web page by the Workbench"
}

:::::::::::::::::::::::::::::::::::::::: challenge

### Practice with Pull Requests (10 mins)
Expand All @@ -178,6 +178,9 @@ Edit `index.md`, following the steps demonstrated earlier to open a pull request

::::::::::::::::::::::::::::::::::::::::::::::::::

Once your changes have been merged and your lesson site rebuilds, check how prerequisites block appears on your lesson's home page.


:::::::::::::::::::::::::::::::: spoiler

### Markdown Rendering on GitHub
Expand Down
Loading
⚡