docs: sync README + docs to the current engine; add structural-editing demo#74
Merged
Merged
Conversation
…g demo
The engine shipped structural overlay CRUD (0.6.40-41), the determinism guard
(0.6.42), and structured ValidationIssue errors (0.6.43), but README/docs still
described the older surface. This brings them in line and proves the
structural-editing claim with a renderable, asset-free demo.
README:
- fix node-type count 6 -> 8 (rect/ellipse/line/text/image/video/path/group)
- complete the CLI table (manifest/lint/verify-overlay/labels/assemble/player/
logo/diff)
- add a "Restructure, don't just re-skin" block (reorder/remove/insert overlays)
- note that `reframe lint` now enforces pure-function-of-time
- add an "Embedding reframe" in-process API section
- bump example count 66 -> 67
docs (Mintlify):
- the-loop.mdx: structural editing + lint enforcement + structured errors
- regen-contract.md: full add/remove/reorder/insert vocabulary + JSON schema
- new cli-reference.mdx and api.mdx; docs.json nav updated
- cross-links to lint/manifest in quickstart/directing/edsl guides
- sync 66 -> 67 across examples.mdx/gallery.mdx/examples README
demo (pure vector, renders standalone from the npm package):
- examples/scenes/vector-montage.ts mirrors photoMontage's addressing contract
- examples/overlays/vector-montage-{restructure,insert}.json
- verified: lint --strict clean, verify-overlay 0 orphans, 3 mp4s render
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
Why
The engine shipped structural overlay CRUD (0.6.40-41), the determinism guard (0.6.42), and structured
ValidationIssueerrors (0.6.43), butREADME.mdanddocs/still described the older surface. This syncs them and proves the structural-editing claim with a renderable, asset-free demo.README
rect/ellipse/line/text/image/video/path/group)manifest/lint/verify-overlay/labels/assemble/player/logo/diffreframe lintnow enforces pure-function-of-timedocs (Mintlify)
the-loop.mdx: structural editing + lint enforcement + structured errorsregen-contract.md: full add/remove/reorder/insert vocabulary table + consolidated JSON schemacli-reference.mdxandapi.mdx;docs.jsonnav updatedlint/manifestin quickstart/directing/edsl guidesexamples.mdx/gallery.mdx/examples READMEdemo (pure vector — renders standalone from the npm package)
examples/scenes/vector-montage.tshand-mirrorsphotoMontage's addressing contract (each shot is the self-contained beatshot-${i}under onemontagebeat)examples/overlays/vector-montage-{restructure,insert}.jsonVerification
pnpm typecheck+pnpm testgreen (400/400)reframe lint --strictclean (100% addressable + deterministic)reframe verify-overlay→ 0 orphans for both overlays🤖 Generated with Claude Code