READING / concepts/repository-orientation.md

A published OKF snapshot. Follow the map, then read at your pace.

Knowledge mapSee how this bundle connects3 concepts · No internal links yetOpen mapHide map
playbookmachine confirmedstable
Verified okfshare team ·
Provenance and verification

Verification history

  1. okfshare team ·

Repository orientation

A CLAUDE.md file is read at the start of every session. Treat it like a README written for a new engineer who is fast, literal, and has no tribal knowledge.

Put in CLAUDE.md

Keep out

Keep it short

Every token in CLAUDE.md is paid on every session. Aim for under 150 lines. When a rule only matters for one subsystem, move it to a nested CLAUDE.md in that directory; Claude Code picks up the nearest file.

Verify it works

Ask a fresh agent session: "What commands would you run before opening a PR?" If the answer is wrong or hesitant, your CLAUDE.md failed its job.

FOCUS READER

Speed read

Paused

Ready

300 wpm

Space play/pause · arrows step or change rate · Escape closes