Method
Each course lives in its own folder and follows the same structure.
Structure of a course
Section titled “Structure of a course”| Page | Role |
|---|---|
index.md — Mission |
Why I’m learning the topic, what I want to be able to do by the end, prerequisites, outline and resources. |
01-…, 02-… — Lessons |
One idea per lesson. Real commands, a summary, exercises with collapsible solutions. |
journal.md — Journal |
Dated progress notes: attempts, errors, open questions, “to verify” items. |
Writing rules
Section titled “Writing rules”- Test before claiming. Anything not yet verified on my machine is marked to verify.
- Cite primary sources. Official documentation, repositories, release notes — no second-hand blogs when it can be avoided.
- Keep the failures. An error encountered (and its cause) is often more instructive than the ideal path.
- Date what changes fast. Preview tools evolve: each course states the version studied.
- Bilingual. English is the reference language; the French version follows under
/fr/.
Adding a course
Section titled “Adding a course”- Create
src/content/docs/<topic>/(English) andsrc/content/docs/fr/<topic>/(French), with identical file names. - Write
index.md(mission), the numbered lessons andjournal.md. - Order the pages with
sidebar: { order: N }in the frontmatter. - Add the group in
astro.config.mjs:
{ label: 'My topic', items: [{ autogenerate: { directory: 'my-topic' } }] }