Skip to content

Commit 5946896

Browse files
travisjneumanclaude
andcommitted
docs: polish README with links to all new files, enable GitHub Discussions
- Add Getting Started and FAQ links to Quick Start section - Update flashcard count from 7 to 16 decks - Add Contributing/CoC links - Add Additional Resources table linking all new documents - GitHub Discussions enabled on the repository Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent db0d261 commit 5946896

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ Open [START_HERE.md](./START_HERE.md) and follow the guide. You'll be writing Py
5555

5656
Never used a terminal before? Start with [00_COMPUTER_LITERACY_PRIMER.md](./00_COMPUTER_LITERACY_PRIMER.md) — it explains everything from scratch.
5757

58+
Not sure how to use this curriculum? Read the [Getting Started Guide](./GETTING_STARTED.md). Have questions? Check the [FAQ](./FAQ.md).
59+
5860
---
5961

6062
## 🗺️ Curriculum Roadmap
@@ -162,8 +164,8 @@ One quiz per concept guide. Run them from the terminal:
162164
python concepts/quizzes/what-is-a-variable-quiz.py
163165
```
164166

165-
### Flashcards (7 decks)
166-
Spaced repetition cards using a Leitner box system. Cards you get right appear less often. Cards you miss come back immediately.
167+
### Flashcards (16 decks)
168+
Spaced repetition cards using a Leitner box system. Cards you get right appear less often. Cards you miss come back immediately. Decks cover all 13 levels plus 4 expansion modules.
167169
```bash
168170
python practice/flashcards/review-runner.py
169171
```
@@ -297,7 +299,22 @@ ruff check .
297299

298300
Contributions are welcome. If you find a typo, a broken link, a test that could be better, or want to add a project — open an issue or submit a pull request.
299301

300-
Please keep contributions consistent with the curriculum's style: plain language, hands-on first, no jargon without explanation.
302+
Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines and [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) for community standards.
303+
304+
---
305+
306+
## 📋 Additional Resources
307+
308+
| Document | Description |
309+
|----------|-------------|
310+
| [Getting Started Guide](./GETTING_STARTED.md) | How to use this curriculum, time estimates, pacing suggestions |
311+
| [FAQ](./FAQ.md) | Common questions from new learners |
312+
| [Curriculum Map](./CURRICULUM_MAP.md) | Visual dependency diagram and projects-at-a-glance table |
313+
| [Validation](./VALIDATION.md) | What the CI checks do and how to run them locally |
314+
| [Tools Guide](./tools/README.md) | Documentation for all curriculum tools (grader, diagnostics, progress tracker) |
315+
| [Contributing](./CONTRIBUTING.md) | How to contribute to this project |
316+
| [Code of Conduct](./CODE_OF_CONDUCT.md) | Community standards |
317+
| [License](./LICENSE) | MIT License |
301318

302319
---
303320

0 commit comments

Comments
 (0)