Skip to content

fix: update contributing guide to new adventrue format #57

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
KatharinaSick merged 1 commit into from
Jun 10, 2026
Merged

fix: update contributing guide to new adventrue format #57

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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/<level>.md` — level guide
- `adventures/planned/00-adventure-name/` — adventure base with `README.md` and `docs/index.yaml`
- `adventures/planned/00-adventure-name/docs/<level>.yaml` — level guide
- `adventures/planned/00-adventure-name/<level>/verify.sh` — verification script skeleton
- `.devcontainer/00-adventure-name_NN-level/` — `devcontainer.json`, `post-create.sh`, `post-start.sh`

Expand Down Expand Up @@ -304,15 +304,15 @@ Not sure if a challenge belongs at Beginner, Intermediate, or Expert? See [Calib

#### 5. Write the Documentation

Fill in the generated `docs/<level>.md` — it already contains the story, objectives, and learning outcomes from the idea file. Add:
Fill in the generated `docs/<level>.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
- Helpful links to external docs

No spoilers — save those for a `solutions/<level>.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

Expand Down