Repository navigation
README: the pool, the tools and the plan as they are - #25
Conversation
The README still described lectures/ and products/ as empty placeholders and listed the pool, the ledger and promotion as future work. - It now opens with what exists: 52 lectures in the pool with their provenance, the pinned and daily-synced mirror, the drift-check and the promote tool. - It adds a "Promoting lectures" section (commands, the collision and stale-copy rules), dp's current address, the ledger and toc baselines in the layout, and a paragraph on the technology register. - The roadmap is replaced by the plan's ten stages and the order of cutovers. - Posture rule 1 now states the exceptions ruled in October: lecture maintenance, the renames with redirects, and the two merges, each its own reviewed pull request in its series. - The banner still leads: nothing here is published yet. Part of QuantEcon/project-monorepo#13. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
🟢 Approval recommended
It is a documentation-only update whose every factual claim (lecture count, file/tool/workflow existence, CLI flags, internal anchors, and layout) was verified against the current codebase with no discrepancies.
0 open findings
What changed in this PR
This PR rewrites README.md to reflect the repository's current state rather than describing it as empty scaffolding. It documents that the shared lecture pool, the provenance ledger, the sync/drift-check/promote tooling, and the mirror now exist, and replaces the old "Roadmap" with a concrete ten-stage "plan." I verified the key claims against the codebase: there are exactly 52 lecture .md files in lectures/; sync/{ledger,state,toc,canonical,manifest}.yml, docs/tech/README.md, the three tools, and the three workflows all exist; the promote CLI supports --toc/--refresh/--exclude/--dry-run with PROMOTE_EXCLUDE: dp jax in drift-check.yml; sync.yml is a daily (17 6 * * *) pin-only job and drift-check.yml runs on its workflow_run completion; and the _static/<slug>/ + _static/_shared/ layout matches. The #the-plan anchor resolves and no stale #roadmap references remain.
Changes:
- Rewrites the status banner/intro and adds a "What exists today" list (pool, mirror, drift-check, promote tool).
- Adds a "Promoting lectures" section and a "The technology register" section; restates the four posture rules with their exceptions and post-cutover edit model.
- Replaces the roadmap with a ten-stage plan; updates the directory layout, the
dplive-site URL, and theproducts/lecturesstate cells.
| File | Description |
|---|---|
| README.md | Documentation refresh accurately describing the existing pool, ledger, mirror, tooling, posture rules, directory layout, and the new ten-stage plan. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Brings the README up to date. It still described
lectures/andproducts/as empty placeholders, and listed the pool, the provenance ledger and promotion as future work.sync/ledger.yml, the pinned and daily-synced mirror, the drift-check, and the promote tool.quantecon.github.io/lecture-dp/);ledger.yml,toc.ymlanddocs/tech/added to the directory layout; and a paragraph orienting a reader to the technology register.The banner still leads: nothing here is published yet, and the series sites stay authoritative. This is QuantEcon/project-monorepo#13, the last set-up item.
🤖 Generated with Claude Code