Docs Navigation Guide

The classroom docs are files. Learn to move through them the same way you move through your home directory.

Start Here

glow -p /docs/README.md

That page is the course map. It links to session guides, quests, command cards, concept cards, and platform rules.

Read A Link

Markdown links look like this:

[S01 self-study](/docs/sessions/S01/self-study.md/)

The part in parentheses is the file path. Open it with glow -p:

glow -p /docs/sessions/S01/self-study.md

If a link starts with /docs, it is an absolute path. You can open it from anywhere.

Move Through The Docs

cd /docs
pwd
ls

Useful places:

• /docs/README.md: course map.
• /docs/sessions/: self-study guides, slides, and recaps by session.
• /docs/quests/README.md: optional quest index.
• /docs/commands/README.md: command card index.
• /docs/concepts/README.md: concept card index.
• /docs/guides/: platform, password, IRC, scoring, and docs navigation guides.

Open files with absolute /docs paths so the command works from anywhere:

glow -p /docs/sessions/S01/self-study.md

Go back to the course map:

glow -p /docs/README.md

Find A File

List every Markdown file:

find /docs -name '*.md' | sort

Find filenames that mention a topic:

find /docs -iname '*ssh*'

Search inside the docs:

grep -Rni 'ssh key' /docs

Read the matching file with glow -p.

Use Glow Without Getting Stuck

• Scroll with the arrow keys, Space, and b.
• Search inside the open file with /, then type the word and press Enter.
• Jump to the next match with n.
• Quit with q.

If glow -p feels too fancy, use less:

less /docs/README.md

Quit less with q.

Before Asking For Help

Do this first:

1. Open the course map: glow -p /docs/README.md.
2. Open the current session guide.
3. Search the docs for the command, concept, or error text.
4. Read one linked command card or concept card.
5. Ask the guide or IRC with the command you ran, the file you read, and the exact error.

Good help request:

I read /docs/sessions/S01/self-study.md and /docs/commands/ssh.md.
I ran: ssh myhandle@lf2607.kolamayermakers.org
The error is: Permission denied.
What should I check next?