docs: complete and polish package READMEs - #47
Merged
Conversation
Every package now has a README. Add package-level docs for @vosjs/timeline, @vosjs/editor, and @vosjs/tween matching the existing house style, and update the root README's Packages table to include @vosjs/tween and @vosjs/cli. Drop the CLI from the roadmap now that it has shipped.
Fix the quick-start camera field (the schema discriminates on `preset`, not `type`), add the missing `@vosjs/core/lint` subpath to both the root and core tables, and document the linter and the three render-template modes in the core README. Add an element-types table to the @vosjs/elements README.
hblee12294
changed the title
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.
Every package now ships a README, and the pre-existing ones are corrected and expanded.
New package READMEs
@vosjs/timeline— deterministic time math: keyframe sampling, GSAP-compatible easings, source-time remapping (trim/split/speed), and the host/program dual-evaluation contract.@vosjs/editor— headless editing infra: patch-based document store, the live-edit classifier, the editor-mode bridge client, element-edit commit helpers, and timeline view-model math.@vosjs/tween— recording a GSAP-dialect timeline into a per-element tween IR, extraction, and the deterministic sampler / spec player.Fixes & improvements to existing READMEs
preset, nottype; added@vosjs/tweenand@vosjs/clito the Packages table; removed the shipped CLI from the roadmap.@vosjs/core: added the missing@vosjs/core/lintsubpath, documented the determinism/dialect linters, and described the three render-template modes (playback/capture-video/capture-thumbnail).@vosjs/elements: added an element-types table (text / image / svg / video / audio).Docs only — no code or version changes, so no changeset. Every documented export and schema field was verified against the source.