@@ -13,8 +13,8 @@ Diffusion Lighthouse website safely and correctly.
1313
1414| You change… | You must run… |
1515| ------------| ---------------|
16- | Paper metadata (titles, venues, relations, tags, notes) | ` build_dataset.py ` |
17- | Citation counts | ` update_citations.py ` → ` build_dataset.py ` |
16+ | Paper metadata (titles, venues, relations, tags, notes) | ` python scripts/ build_dataset.py` |
17+ | Citation counts | ` python scripts/ update_citations.py` → ` python scripts/ build_dataset.py` |
1818| UI / wording / behavior | edit files in ` site/ ` only |
1919| README framing | edit README only (no build needed) |
2020
@@ -99,7 +99,7 @@ This is the most common cause of:
9999Quick checks:
100100
101101``` bash
102- ls site/public/data/papers.json
102+ ls -lh site/public/data/papers.json
103103```
104104
105105Paper count:
125125
126126### 5️⃣ View the site locally
127127
128+ From the repo root:
129+
128130``` bash
129131cd site
130- python -m http.server
132+ python -m http.server 8000
131133```
132134
133135Open:
@@ -137,7 +139,7 @@ http://localhost:8000
137139
138140Hard refresh if needed:
139141- macOS: ` Cmd + Shift + R `
140- - Linux / Windows: ` Ctrl + Shift + R `
142+ - Windows/Linux : ` Ctrl + Shift + R `
141143
142144---
143145
@@ -159,10 +161,15 @@ site/style.css
159161
160162---
161163
162- ### Quick sanity check
164+ ### 7️⃣ Run doctor checks (recommended)
165+
163166``` bash
164167python scripts/doctor.py
168+ ```
165169
170+ If the doctor fails, fix issues ** in YAML** or the scripts — do ** not** hand-edit ` papers.json ` .
171+
172+ ---
166173
167174## 🧠 Mental model (important)
168175
@@ -183,6 +190,7 @@ If something looks wrong on the site:
183190- Expecting README edits to affect the website
184191- Treating missing citations as errors
185192- Editing ` papers.json ` directly (it is a build artifact)
193+ - Running the site from the wrong folder (serve from ` site/ ` )
186194
187195---
188196
@@ -191,8 +199,8 @@ If something looks wrong on the site:
191199Stop iterating if:
192200- the site loads correctly
193201- papers render and open
194- - relations work
195- - links resolve
202+ - relations work (incoming/outgoing shown in modal)
203+ - links resolve to canonical sources
196204
197205Citation completeness is ** explicitly not a goal** .
198206
@@ -206,8 +214,9 @@ Every update:
2062141. Edit data/papers.yaml
2072152. (Optional) python scripts/update_citations.py
2082163. python scripts/build_dataset.py ← required
209- 4. Refresh site
210- 5. Commit & push
217+ 4. cd site && python -m http.server 8000
218+ 5. Refresh site
219+ 6. Commit & push
211220```
212221
213222---
0 commit comments