From b42bf3fa4514a90d17698ec3abad2d36385687f6 Mon Sep 17 00:00:00 2001 From: Katharina Sick Date: Wed, 10 Jun 2026 12:55:05 +0200 Subject: [PATCH] fix: update contributing guide to new adventrue format Signed-off-by: Katharina Sick --- AGENTS.md | 2 +- CONTRIBUTING.md | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index d8dc2823..0776c283 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -29,7 +29,7 @@ Never create adventure files manually. The correct flow is: ## Building Challenges -> Read [docs/contributing/adventures.md](./docs/contributing/adventures.md) first — it covers the full step-by-step process. +> Read [CONTRIBUTING.md](./CONTRIBUTING.md) first — it covers the full step-by-step process. > The sections below capture things that are easy to miss on top of that guide. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6f5fdb83..461f591b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -211,10 +211,10 @@ Use `00` as the adventure number during development. When your adventure is sche adventures/planned/00-adventure-name/ ├── README.md # Brief intro + link to docs ├── docs/ -│ ├── index.md # Adventure introduction -│ ├── beginner.md # Level guide -│ ├── intermediate.md -│ ├── expert.md +│ ├── index.yaml # Adventure introduction +│ ├── beginner.yaml # Level guide +│ ├── intermediate.yaml +│ ├── expert.yaml │ └── solutions/ │ ├── beginner.md # Solution walkthrough │ ├── intermediate.md @@ -245,8 +245,8 @@ make new-adventure This will prompt you to select an adventure and level, then generate: -- `adventures/planned/00-adventure-name/` — adventure base with `README.md` and `docs/index.md` -- `adventures/planned/00-adventure-name/docs/.md` — level guide +- `adventures/planned/00-adventure-name/` — adventure base with `README.md` and `docs/index.yaml` +- `adventures/planned/00-adventure-name/docs/.yaml` — level guide - `adventures/planned/00-adventure-name//verify.sh` — verification script skeleton - `.devcontainer/00-adventure-name_NN-level/` — `devcontainer.json`, `post-create.sh`, `post-start.sh` @@ -304,7 +304,7 @@ Not sure if a challenge belongs at Beginner, Intermediate, or Expert? See [Calib #### 5. Write the Documentation -Fill in the generated `docs/.md` — it already contains the story, objectives, and learning outcomes from the idea file. Add: +Fill in the generated `docs/.yaml` — it already contains the story, objectives, and learning outcomes from the idea file. Add: - Architecture overview (how the level is set up) - UI access instructions with port numbers - Where to start investigating @@ -312,7 +312,7 @@ Fill in the generated `docs/.md` — it already contains the story, objec No spoilers — save those for a `solutions/.md` file. -See [Adventure 01's beginner level](adventures/01-echoes-lost-in-orbit/docs/beginner.md) for a good example. +See [Lex Imperfecta's beginner level](adventures/05-lex-imperfecta/docs/beginner.yaml) for a good example. #### 6. Create the Verification Script