Skip to content

Audit and update manual based on Snap! git history and HISTORY.md - #53

Closed
cycomachead wants to merge 1 commit into
mainfrom
cycomachead/16-audit-manual-history/1
Closed

cycomachead wants to merge 1 commit into
mainfrom
cycomachead/16-audit-manual-history/1

Conversation

@cycomachead

Copy link
Copy Markdown
Member

Manual content audit against Snap! 12.0.6

Adds a comprehensive audit document (docs/content-audit-2026-08.md) comparing the current manual (based on the Snap! 8.0 PDF, August 2022) against the Snap! source and HISTORY.md at jmoenig/snap v12.0.6. This serves as the prioritized roadmap for updating the manual, which is currently four major releases behind.

Changes

  • New file: docs/content-audit-2026-08.md — full audit report covering all 12 chapters and appendices

The audit is organized into two parts:

Part A — Verifiably wrong or out of date (19 items):

  • call/run w/continuation still taught as palette primitives (removed in 9.0.0; now library-only)
  • Chapter 7 names the wrong block for sprite-to-sprite messaging (say vs. ask () for ())
  • Chapter 12's Settings menu section describes a flat layout replaced by submenus in 12.0.0
  • Chapter 5's input-type dialog is wrong: Object slot replaced by Color in 11.0.0, grid rearranged
  • "Three block shapes" — there are four since custom Event Hat blocks in 10.3.0
  • min/max/atan2 described as hidden relabel-only blocks (visible in palette since 9.1.0)
  • Colors framed as a library feature when they've been a built-in first-class type since 11.0.0
  • Several medium/low priority items (stale url fallback claim, incomplete length of dropdown list, outdated hardware docs, etc.)

Part B — Missing from the manual (20 items):

  • Variadic if/else-if (9.0.0)
  • First-class colors primitive suite (11.0.0)
  • Lists as dictionaries (8.1.0)
  • OOP 2.0 data objects and super-calls (10.1.0/12.0.0)
  • "Blocks all the way" / editable primitives (10.0.0)
  • Libraries appendix is an empty stub while ~60 libraries ship
  • Custom hat blocks, request reporter, this () introspection reporter, and more

The report also documents two HISTORY.md claims that did not reproduce in the current source, so those won't be incorrectly "fixed."

Reviewer context

All findings were verified against the Snap! source tree (with src/*.js references) rather than trusting the changelog alone. Items are ordered by priority within each section. The audit covers common features for typical users and teachers; obscure extensions and screenshot styling drift are excluded.


Superconductor Ticket Implementation | Guided Review

Perform a comprehensive audit of the manual against the @jmoenig/snap
repository (v12.0.6) and HISTORY.md. Identify critical discrepancies
where the manual is four major releases behind (Snap! 8.0 baseline).

Key findings documented in docs/content-audit-2026-08.md:
- Removed primitives (call/cc) still taught as core features.
- UI changes in Settings and Input Type dialogs.
- Missing core features: variadic if, first-class colors, and OOP 2.0.
- Outdated hardware and library documentation.

This audit serves as the roadmap for updating the manual to match the
current state of Snap!.

Co-authored-by: Claude Code <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant