docs: add per-package READMEs and polish root docs for OSS launch#34
Merged
jrusso1020 merged 3 commits intomainfrom Mar 24, 2026
Merged
docs: add per-package READMEs and polish root docs for OSS launch#34jrusso1020 merged 3 commits intomainfrom
jrusso1020 merged 3 commits intomainfrom
Conversation
- Add READMEs for all 5 packages (core, engine, producer, cli, studio) with install, overview, basic usage, and links to full docs - Rewrite core README from internal doc to OSS-facing format - Polish root README: add badges, packages table, docs link, requirements - Add AI usage policy and BDFL governance statement to CONTRIBUTING.md - Genericize license references (pending final license decision) - Docs URL set to hyperframes.heygen.com Addresses VA-850. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Lint (oxlint) only runs when code changes are detected - Format (oxfmt) runs on all PRs including docs-only changes - Update path filter: pnpm-lock.yaml → bun.lock Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
jrusso1020
force-pushed
the
docs/oss-documentation
branch
from
bb65407 to
039985b
Compare
miguel-heygen
approved these changes
Mar 24, 2026
Collaborator
|
The bun migration (#28) has merged. Three new lines in this PR still reference Should be: |
Collaborator
Author
will address in a new PR 😓 |
1 task
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
3 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.
What
Add per-package READMEs, polish root documentation files, and fix CI for docs-only PRs.
Why
VA-850 requires all documentation to be authored before the public repo launch. The
docs/packages/*.mdxpages cover full detail; these READMEs serve the npm/GitHub audience with concise install + overview + links to the docs site.How
Per-package READMEs (new for engine, producer, cli, studio; rewritten for core):
Root README polish:
initcommandCONTRIBUTING.md additions:
CI: split lint from format:
Lintjob (oxlint) now only runs on code changesFormatjob (oxfmt) runs on all PRs — catches unformatted docs/markdownpnpm-lock.yamlpath filter tobun.lockTest plan
Formatjob runs on this docs-only PRLintjob is skipped (no code changes)