Repository navigation
docs: per-example markdown docs with generated SVGs and a generate task - #7
Merged
Merged
Conversation
…amples task - Add doc/examples/<name>/ with a minimal README and generated SVGs for cubic-disarray and noodle-love. - Add examples/update-example-svgs.sh and a deno task generate:examples that regenerates all example SVGs deterministically. - Refactor examples/noodle_love.ts to the Settings/Vormen runner with a fixed seed so its output is reproducible. - Rename doc/cubic-disarray.svg to doc/readme-example.svg to clarify it is the README's example, and document the task in the README. - Add an integration test asserting deterministic regeneration. Co-authored-by: berkes <berkes@users.noreply.github.com>
Co-authored-by: berkes <berkes@users.noreply.github.com>
berkes
marked this pull request as ready for review
October 5, 2026 15:32
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
2 participants
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
doc/examples/<name>/: a minimalREADME.mdplus generated SVGs insvg/(cubic-disarrayhas two, showcasing therotationStrengthsetting;noodle-lovehas one).deno task generate:examples(rootdeno.json) shells out to the undocumentedexamples/update-example-svgs.sh, which runs every example withdeno run ... render -oand regenerates all SVGs deterministically.examples/noodle_love.tsto theSettings/Vormenrunner with a fixed seed so regeneration is byte-identical.doc/cubic-disarray.svgtodoc/readme-example.svg(it is the README's example) and updated the link; fixed a broken link syntax there.deno task generate:examplesanddoc/examples/.Verification
deno run check:allpasses (lint, fmt, check, 67 tests).__tests__/integration/generate_examples_test.tsruns the task twice and asserts byte-identical SVG output.Closes #6