The READMEs say what the packages do now - #130
Merged
Merged
Conversation
Every README in the repo was audited against the source it describes and rewritten where it had drifted. Root: the two ways in (the CLI and the engine as a library), a quick start that compiles (version, duration and camera are required; compileVosConfig returns a module and generateRenderTemplate the page), the package table ordered by dependency layer, a diagram of how the packages fit, links to the docs and the schemas. The unshipped roadmap is gone. CONTRIBUTING: setup, the layout with its dependency direction, the rules that keep the engine deterministic and product-free, the release mechanics (OIDC, the first publish of a new name, CI on the release PR). SECURITY names what is in scope for the CLI too. Packages: studio-core was still titled by its old scope name and pointed at a package that no longer exists; its two headline signatures were wrong and it listed five camera styles of eight. The timeline, tween and editor examples called functions with the wrong argument shapes. Shared and render-core listed modules that left them. Elements called three an optional peer. The CLI README now covers every verb and flag the binary accepts, the full take directory, the actions.json step fields, the delivery channels and the vos.so sub-verbs, with the max-duration default described as the live cap it is. Two small code fixes ride along so the docs are true: --composed on vos deliver parses as a bare flag, and vos help lists vos actions and stops quoting a fixed recording cap.
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 README in the repo audited against the source and rewritten where it had drifted, plus CONTRIBUTING and SECURITY.
What was wrong
packages/studio-core/README.mdwas titled@vosso/studio-core, pointed at../vos-plugin(deleted), gaveprojectFromArtifact(artifact)andplanAutoZoom(doc, options)(the real signatures take a video URL and a cursor track), listed five of the eight camera styles, and never mentioned the document family, the digest, the destinations table, the backdrop mechanism or the speed and tilt planners.sample(track, t, resolveEase)(the third argument is a lerp),createTweenRecorder({ backend })(positional),recorder.specs(on the timeline, not the recorder),createSampler(doc).seek()returning a frame (it writes onto targets and returns nothing),createProjectStore({ doc })(positional),classifyEdit(prev, next)(a required third argument, and it returns a list).sharedstill listed the differ and the limits table, which left@vosjs/sharedin 0.3/0.4;render-coredescribed the audio producer under a retired name and missedmuxEncodedExport.threean optional peer (it is required).--max-durationdefaults to 1800 s (it reads the cap live since 0.13), used a retired backdrop URL shape, said an unknown--backgroundextension means an image (it means video), and never listedfolder,asset,recipe,--fresh,--no-frames,--times, theshorts-linkedinchannel, stepids, or the program-directory case ofvos validate.What changed
.d.tsfiles.--composedonvos deliverparses as a bare flag (it was missing from the boolean set and demanded a value), andvos helplistsvos actionsand describes the live recording cap. Patch changesets for the CLI fix and for the README updates, so npm shows the new pages.Found, not fixed here
vos pull <take> --checkand--sinceare in the plugin help text, but the take path neither parses--checkas a flag nor reads--since.vos render <dir>sniffs a take bydoc.jsonalone, so a program directory carrying a program document is routed to the take renderer and fails on a missingmeta.json.Checks
pnpm build,pnpm --filter @vosjs/cli typecheck | lint | test(192 tests),pnpm checkall green.