Your study folder
All data is in plain markdown files. You can read and edit them.
How the coach finds the folder
The coach looks for a file named STUDY.md. It looks in this order:
- The current folder.
- The
study/folder. - Each parent folder.
If it does not find the file, it offers to make a new folder with init.
The files
| Path | Contents |
|---|---|
STUDY.md | Settings, goal, learner profile, daily schedule, rules |
DASHBOARD.md | Progress numbers. A script makes this file. Do not edit it. |
curriculum/plan.md | The full plan. This is the main source. |
curriculum/brief.md | Goal, what you know, time, rules. The planner writes it. |
curriculum/gaps.md | Your capabilities, the gaps, and the topics that the planner skips. The planner writes it. |
curriculum/exit-test.md | The checks that show you reached the goal |
curriculum/changes.md | A log of all changes to the plan |
curriculum/proposals.md | Possible changes that wait for a decision |
days/dayNN.md | One file for each day: tasks, done criteria, log |
courses/, books/ | Progress for each course and book |
articles/ | Notes and questions for each article or paper |
concepts/ | One file for each concept: depth, evidence, next review |
ideas/ | New ideas (inbox) and ideas for later (parking lot) |
projects/ | Your code and work |
posts/ | Blog drafts, short posts, and a list of published posts |
reviews/ | One review for each week |
index.html, progress.js | The optional web page and its data. See Go online. |
private.md | Personal notes. The coach never puts this file online. |
A day file
Each day file has four parts:
## Plan - [ ] **Learn:** ... - [ ] **Build:** ... - [ ] **Post:** ... ## Done when - [ ] A result that you can see or measure ## Log - **Done:** - **Blocked:** - **Tomorrow's first task:** ## Notes
Use these marks in the boxes:
[ ]= not done[x]= done[-]= dropped (write the reason in Notes)
Items with (stretch) or (if behind) are optional. They do not count as owed work.
The dashboard
A script reads all the files and writes DASHBOARD.md. The coach runs this script first, each time. It shows:
- Day N of M, and your pace
- Items that you owe
- Your streak and missed days
- Concepts that are due for review
- Errors that occur again and again
- Plan changes and posts
The coach uses the numbers from the script. It does not count by hand.
Next: The commands →