Skip to content

Commit 471dfcf

Browse files
Add unstable lessons to root myst.yml TOC
- Add 'Unstable' section to project.toc in myst.yml with all 11 unstable files - Update AGENTS.md: repository structure, build commands, and Adding a New Lesson workflow - Fix encoding issue (em dash character) in AGENTS.md
1 parent fbf84a2 commit 471dfcf

2 files changed

Lines changed: 25 additions & 7 deletions

File tree

AGENTS.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
| `unstable/` | Work-in-progress text-only MyST notebooks (`.md` with `{code-cell}` directives) |
1515
| `other/` | Supplementary content (e.g. `dqrobotics.md`) |
1616
| `convert_to_myst.py` | Script: converts `basic_lessons/*.ipynb``unstable/*.md` |
17-
| `myst.yml` | MyST project config (root): LaTeX macros, TOC, site options |
18-
| `unstable/myst.yml` | MyST project config (unstable): mirrors root with adjusted paths |
17+
| `myst.yml` | MyST project config (root): LaTeX macros, TOC (including unstable section), site options |
18+
| `unstable/myst.yml` | Standalone MyST project config for unstable-only builds (optional) |
1919
| `build_html.sh` | Build script for `jupyter-book` (legacy pipeline) |
2020
| `conf.py` | MyST parser extensions (`dollarmath`) |
2121
| `_build/` | Build artifacts (excluded from git via `unstable/.gitignore`) |
@@ -111,15 +111,20 @@ pip install jupyter-book --pre
111111

112112
### Build Commands
113113

114-
**MyST build (unstable/):**
114+
**MyST build (root — includes all lessons + unstable):**
115115
```bash
116-
cd unstable
117-
myst build --execute --html
116+
myst build --html
118117
```
119118
- `--execute` runs all code cells and caches results in `_build/execute/`
120119
- `--html` produces HTML output in `_build/html/`
121120
- Site format (JSON) goes to `_build/site/`
122121

122+
**MyST build (unstable only — optional):**
123+
```bash
124+
cd unstable
125+
myst build --execute --html
126+
```
127+
123128
**Legacy jupyter-book build (root):**
124129
```bash
125130
chmod +x build_html.sh
@@ -194,6 +199,6 @@ Thank you! Please report it at https://github.com/MarinhoLab/OpenExecutableBooks
194199
3. Add LaTeX macro raw cell (or markdown cell with `vscode` language metadata)
195200
4. Update `myst.yml` → add new file to `project.toc` list
196201
5. Run `python3 convert_to_myst.py` to regenerate `unstable/`
197-
6. Update `unstable/myst.yml` → add new `.md` file to TOC
198-
7. Test: `cd unstable && myst build --execute --html`
202+
6. Update `myst.yml` → add new unstable `.md` file to the "Unstable" section in `project.toc`
203+
7. Test: `myst build --html` from the repository root
199204
8. Open PR with descriptive title and body

myst.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,19 @@ project:
4646
- file: book.md
4747
- file: CHANGELOG.md
4848
- file: TODO.md
49+
- title: "Unstable"
50+
children:
51+
- file: unstable/README.md
52+
- file: unstable/lesson1_tutorial.md
53+
- file: unstable/lesson2_tutorial.md
54+
- file: unstable/lesson3_tutorial.md
55+
- file: unstable/lesson4_tutorial.md
56+
- file: unstable/lesson5_tutorial.md
57+
- file: unstable/lesson1_exercise_answers.md
58+
- file: unstable/lesson2_exercise_answers.md
59+
- file: unstable/lesson3_exercise_answers.md
60+
- file: unstable/lesson4_exercise_answers.md
61+
- file: unstable/lesson5_exercise_answers.md
4962

5063
site:
5164
template: book-theme

0 commit comments

Comments
 (0)