Skip to content

Commit a84c765

Browse files
committed
fix: name id & docs formatting & CLI tool;
1 parent b596b8a commit a84c765

File tree

8 files changed

+35
-33
lines changed

8 files changed

+35
-33
lines changed

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,17 @@ This is the **official template** for constructing trackable learning systems fr
2727

2828
## Folder Structure
2929

30-
| Folder | Emoji | Role |
31-
| ------------ | ----- | ----------------------------------------------------- |
32-
| `docs/` | 🗂️ | Schemas, maps, notes, distilled knowledge |
33-
| `logs/` | 📃 | Daily logs, blockers (`🚧`), insight pings |
34-
| `loop/` | 🔁 | P.A.C.E.R. loops: Plan → Act → Check → Edit → Reflect |
35-
| `outputs/` | 🚀 | Public-facing artifacts: blog, repo, showcase |
36-
| `track.json` | | (Optional) Track metadata for integration |
37-
| `LICENSE` | | MIT License |
38-
| `README.md` | | This Document |
30+
| Folder | Symbol | Role |
31+
| ------------ | ------ | ----------------------------------------------------- |
32+
| `docs/` | 🗂️ | Schemas, maps, notes, distilled knowledge |
33+
| `logs/` | 📃 | Daily logs, blockers (`🚧`), insight pings |
34+
| `loop/` | 🔁 | P.A.C.E.R. loops: Plan → Act → Check → Edit → Reflect |
35+
| `outputs/` | 🚀 | Public-facing artifacts: blog, repo, showcase |
36+
| `track.json` | | (Optional) Track metadata for integration |
37+
| `LICENSE` | | MIT License |
38+
| `README.md` | | This Document |
39+
40+
> All symbols in this repo follow SMOS's [Naming Protocol Emoji](https://github.com/secondmindlab/secondmindlab/blob/19a71aa799d875c2b5dc4b7acda42394bb10f589/meta/naming-protocol-emoji.md). You can either keep this convention or adopt your own style.
3941
4042
## Protocol Flow
4143

@@ -63,7 +65,7 @@ Each learning unit runs through the **P.A.C.E.R. loop** — a minimal feedback p
6365
| `Edit` | Refactor, simplify, correct blindspots |
6466
| `Reflect` | Meta-log insights, blockers, claims |
6567

66-
Each folder in `loop/Week-X/` should contain a `pacer.yaml` or markdown journal documenting this cycle.
68+
Each folder in `loop/week-xx-x/` should contain a `pacer.yaml` or markdown journal documenting this cycle.
6769

6870
## Usage Instructions
6971

@@ -77,19 +79,19 @@ Each folder in `loop/Week-X/` should contain a `pacer.yaml` or markdown journal
7779
- New loop via CLI (Recommend) `python scripts/smos.py week-01-c --topic="Memory & Pointers"`
7880
- Drop notes into `docs/`
7981
- Write blockers / insight logs in `logs/`
80-
- Launch a loop via `loop/week-01/pacer.yaml`, `loop/week-01/claim.md`, `loop/week-01/reflect.md`
82+
- Launch a loop via `loop/week-01-c/pacer.yaml`, `loop/week-01-c/claim.md`, `loop/week-01-c/reflect.md`
8183
- Push deliverables to `outputs/`
8284

8385
#### Example:
8486

8587
```bash
8688
track-cs50x/
87-
├── docs/week-01.md # Schema of memory model
88-
├── logs/YYYY-MM-DD-week-01.md # Blocker resolution
89-
├── loop/week-01/pacer.yaml # P.A.C.E.R. config
90-
├── loop/week-01/claim.md # Distilled knowledge lock
91-
├── loop/week-01/reflect.md # Meta-log & feedback
92-
├── outputs/week-01-output.md # Artifact: reflection + code
89+
├── docs/week-01-c.md # Schema of memory model
90+
├── logs/YYYY-MM-DD-week-01-c.md # Blocker resolution
91+
├── loop/week-01-c/pacer.yaml # P.A.C.E.R. config
92+
├── loop/week-01-c/claim.md # Distilled knowledge lock
93+
├── loop/week-01-c/reflect.md # Meta-log & feedback
94+
├── outputs/week-01-c/output.md # Artifact: reflection + code
9395
```
9496

9597
#### Naming Convention (Optional):

docs/week-01.md renamed to docs/week-01-c.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ List insights that are **non-obvious**, and **must be claimed explicitly**, not
3939

4040
| ⌬ ID | Claim Statement | Trigger Point | Verified In |
4141
| ---- | -------------------------------------------- | ------------- | ------------------------- |
42-
| 001 | "A pointer holds an address, not the value" | Lecture Q\&A | `logs/2025-05-16-log.md` |
43-
| 002 | "Refactoring reveals abstraction boundaries" | During pset | `loop/week-01/pacer.yaml` |
42+
| 001 | "A pointer holds an address, not the value" | Lecture Q\&A | `logs/YYYY-MM-DD-week-01-c.md` |
43+
| 002 | "Refactoring reveals abstraction boundaries" | During pset | `loop/week-01-c/pacer.yaml` |
4444

4545
## 🚧 Blockers / Ambiguities
4646

@@ -68,8 +68,8 @@ List insights that are **non-obvious**, and **must be claimed explicitly**, not
6868

6969
| Loop Phase | Linked File |
7070
| ---------- | ---------------------------- |
71-
| Plan | `loop/week-01/pacer.yaml` |
72-
| Reflect | `logs/YYYY-MM-DD-week-01.md` |
71+
| Plan | `loop/week-01-c/pacer.yaml` |
72+
| Reflect | `logs/YYYY-MM-DD-week-01-c.md` |
7373

7474
---
7575

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
**Current Phase:** Debug + Reflection
99
**Related files:**
1010

11-
- `docs/week-01.md`
12-
- `loop/week-01/pacer.yaml`
13-
- `outputs/week-01-output.md`
11+
- `docs/week-01-c.md`
12+
- `loop/week-01-c/pacer.yaml`
13+
- `outputs/week-01-c/output.md`
1414

1515
## 2. 🚧 Blockers / Bugs / Blindspots
1616

@@ -41,7 +41,7 @@
4141

4242
## 6. Next Steps
4343

44-
- Update `outputs/week-01-output.md` with fixed version + ⌬ claims
44+
- Update `outputs/week-01-c/output.md` with fixed version + ⌬ claims
4545
- Start new PACER loop for Week-02
4646
- Share selected insight card to LinkedIn ("⌬ Debug = trace > theory")
4747

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313

1414
## Evidence
1515

16-
- Verified via: [`logs/YYYY-MM-DD-week-01.md`](../../logs/YYYY-MM-DD-week-01.md)
17-
- Output artifact: [`outputs/week-01-output.md`](../../outputs/week-01-output.md)
16+
- Verified via: [`logs/YYYY-MM-DD-week-01-c.md`](../../logs/YYYY-MM-DD-week-01-c.md)
17+
- Output artifact: [`outputs/week-01-c/output.md`](../../outputs/week-01-c/output.md)
1818
- Source of knowledge: CS50x Lectures + Pset1
1919

2020
## Note
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# loop/week-01/pacer.yaml
1+
# loop/week-01-c/pacer.yaml
22

3-
loop_id: week-01
3+
loop_id: week-01-c
44
title: '[PROJECT / PS]: <Name of Project, Problem Set, or Concept>'
55
date_started: 2025-05-18
66
date_finished: null
File renamed without changes.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,15 +68,15 @@ Brief description — what did you make / produce?
6868
- ⌬ Claim: `Memory tracing = 4-layer address mental model`
6969
- Situation: `While debugging segfault`
7070
- Impact: `Accelerated understanding of stack/heap`
71-
- Verified: [`logs/YYYY-MM-DD-week-01.md`](../logs/YYYY-MM-DD-week-01.md)
71+
- Verified: [`logs/YYYY-MM-DD-week-01-c.md`](../logs/YYYY-MM-DD-week-01-c.md)
7272

7373
---
7474

7575
## References
7676

7777
- Links to doc, forums, other outputs
7878

79-
> 📏 **Protocol Tag**: `Verified: logs/YYYY-MM-DD-week-01.md`
79+
> 📏 **Protocol Tag**: `Verified: logs/YYYY-MM-DD-week-01-c.md`
8080
> 📣 ⌬ Claim Origin: `"Pointer tracing = mental model of memory layers"`
8181
8282
---

scripts/smos.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ def init_loop(loop_id, topic):
8181
TEMPLATE_REFLECT.format(loop_id=loop_id, topic=topic),
8282
)
8383
create_file(
84-
f"outputs/{loop_id}/{loop_id}-output.md",
84+
f"outputs/{loop_id}/output.md",
8585
TEMPLATE_OUTPUT.format(loop_id=loop_id, topic=topic, today=today),
8686
)
8787

@@ -90,7 +90,7 @@ def init_loop(loop_id, topic):
9090
parser = argparse.ArgumentParser(
9191
description="Initialize a new SMOS learning loop."
9292
)
93-
parser.add_argument("loop_id", type=str, help="Loop ID (e.g. week-01)")
93+
parser.add_argument("loop_id", type=str, help="Loop ID (e.g. week-01-c)")
9494
parser.add_argument(
9595
"--topic", type=str, required=True, help="Topic or focus of the loop"
9696
)

0 commit comments

Comments
 (0)