docs: fix doc-audit gaps and add pedagogy review#40
Merged
Conversation
Resolves the two staleness gaps from the documentation audit and records the instructional-design review and session report. - tutorial-forge-spec.md: add a "Historical design document" banner that marks it pre-v0.1, settles the final names (tutorial-forge / tutorial-forge-cli / bin tutorial-forge+tforge), and points to README/docs/CHANGELOG as authoritative (#33). - Move ISSUE-ACTION-REPORT.md out of repo root to docs/reviews/2026-06-13-issue-action-report.md (#34). - getting-started.md: document the render --out-dir and --concurrency flags. - Add docs/reviews/2026-06-13-pedagogy-review.md (instructional-designer) and docs/reviews/2026-06-13-report-for-john.md (session report). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Resolves the two staleness gaps surfaced by the documentation audit and records the instructional-design review of the docs plus a session report.
tutorial-forge-spec.md— added a "Historical design document" banner: marks it pre-v0.1, settles the final names (tutorial-forge/tutorial-forge-cli/ bintutorial-forge+tforge), and points to README/docs/CHANGELOG as authoritative. Closes Spec doc (tutorial-forge-spec.md) is stale on finalized decisions (bin name, npm scope, CLI flag list) #33.ISSUE-ACTION-REPORT.mdout of the repo root →docs/reviews/2026-06-13-issue-action-report.md. Closes ISSUE-ACTION-REPORT.md is a point-in-time artifact checked into repo root — move or gitignore #34.getting-started.md— documented the previously-undocumentedrender --out-dirand--concurrencyflags (verified againstrender.ts).docs/reviews/2026-06-13-pedagogy-review.md(instructional-designer) anddocs/reviews/2026-06-13-report-for-john.md(session report).The user-facing docs were already accurate with the 0.10.0 surface; these are the only gaps found, both non-user-facing. No code changes.
Follow-on
The pedagogy review spawned backlog issues #35–#39; this PR is docs-only.
🤖 Generated with Claude Code