Skip to content

Commit 891c56a

Browse files
courses -> resources
1 parent 6469ad0 commit 891c56a

File tree

5 files changed

+21
-21
lines changed

5 files changed

+21
-21
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
Welcome! This repository is a **template** for launching your own Research Coding Community Coding Club website using **Jupyter Book**. It includes:
55

6-
- 📚 A ready-to-edit site structure (home, community pages, courses)
6+
- 📚 A ready-to-edit site structure (home, community pages, resources)
77
- ✅ Working **GitHub Actions** for CI/CD to **deploy to GitHub Pages**
88
- 🧩 **Interactive quizzes** via `jupyterquiz` with sample content
99
- 🧪 Optional **accessibility checks** workflow (Pa11y)
@@ -28,8 +28,8 @@ Welcome! This repository is a **template** for launching your own Research Codin
2828
4. **Add or edit content**
2929
- Update `home_page.md`.
3030
- Edit community pages in `community/`.
31-
- Add/modify courses in `courses/`, update `_toc.yml` accordingly.
32-
- Try the quiz in `courses/example_course/example_lesson.ipynb`.
31+
- Add/modify resources in `resources/`, update `_toc.yml` accordingly.
32+
- Try the quiz in `resources/example_resource/example_lesson.ipynb`.
3333

3434
5. **Push to `main`**
3535
- GitHub Actions will build and deploy your site automatically.
@@ -45,9 +45,9 @@ Welcome! This repository is a **template** for launching your own Research Codin
4545
├─ _toc.yml # Table of contents (navigation)
4646
├─ home_page.md # Landing page
4747
├─ community/ # Community pages (About, Code of Conduct, Join)
48-
├─ courses/
49-
│ └─ example_course/
50-
│ ├─ README.md # Course overview
48+
├─ resources/
49+
│ └─ example_resources/
50+
│ ├─ README.md # Resource overview
5151
│ └─ example_lesson.ipynb # Example notebook with quiz
5252
├─ quizzes/
5353
│ └─ sample_quiz.json # Example quiz
@@ -68,7 +68,7 @@ Welcome! This repository is a **template** for launching your own Research Codin
6868

6969
- **Branding:** Replace `_static/logo.png` and set the `logo:` path in `_config.yml`.
7070
- **Theme:** Jupyter Book uses Sphinx Book Theme. You can add custom CSS in `_static/` and reference it in `_config.yml`.
71-
- **Content:** Add new courses in `courses/your_course/` and include them in `_toc.yml`.
71+
- **Content:** Add new resources in `resources/your_resource/` and include them in `_toc.yml`.
7272

7373
---
7474

_toc.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ parts:
1010
- file: community/join
1111
- file: community/code_of_conduct
1212

13-
- caption: Courses
13+
- caption: Resources
1414
chapters:
15-
- file: courses/example_course/README
15+
- file: resources/example_resource/README
1616
sections:
17-
- file: courses/example_course/example_lesson
17+
- file: resources/example_resource/example_lesson

courses/example_course/README.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

resources/example_resource/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
# Example Resource
3+
4+
This is a placeholder resource. Replace with your own notebooks, datasets, and exercises.
5+
6+
**Learning objectives (example):**
7+
- Understand topic X
8+
- Practice skill Y
9+
- Build a small project Z
10+
11+
Navigate to **`example_resource.ipynb`** to see an embedded interactive quiz.

0 commit comments

Comments
 (0)