Skip to content

docs: update docs and README to reflect video support#163

Merged
streamer45 merged 1 commit intovideofrom
devin/1773569202-docs-video-update
Mar 15, 2026
Merged

docs: update docs and README to reflect video support#163
streamer45 merged 1 commit intovideofrom
devin/1773569202-docs-video-update

Conversation

@staging-devin-ai-integration
Copy link
Copy Markdown
Contributor

@staging-devin-ai-integration staging-devin-ai-integration bot commented Mar 15, 2026

Summary

Updates documentation across the repo to reflect that basic video support (VP9 encode/decode, compositor, WebM muxing) is now implemented on the video branch, rather than being described as future/roadmap-only.

Files changed:

  • README.md: Updated tagline (audio/video), screenshot caption (media processing), added video compositing use case, updated media focus from "audio-first today… Video on roadmap" to "audio and basic video"
  • ROADMAP.md: Struck through 3 shipped video items (video packet types, VP9 baseline, compositor MVP); kept MoQ/Hang interop and golden-path demo as still in-progress
  • docs/index.mdx: Updated hero tagline, "who is this for" section, added video compositing bullet to "what you can build"
  • docs/architecture/overview.md: Added video to built-in node categories
  • docs/guides/performance.md: Updated "audio" → "audio/video" in the advanced buffers warning, added VideoFramePool mention in the Frame Pool section
  • crates/nodes/README.md: Added video::* to the node implementation list

Review & Testing Checklist for Human

  • Read through each change to confirm the video capability descriptions are accurate and not overstated (basic VP9 + compositor + WebM muxing — not full production video)
  • Verify the ROADMAP.md strikethroughs match what's actually shipped vs still in-progress (MoQ/Hang interop and golden-path demo are kept un-struck)

Notes

This is a docs-only change — no code changes. All edits are minimal and focused on replacing audio-only language with audio+video where the video branch has shipped the corresponding functionality.

Link to Devin session: https://staging.itsdev.in/sessions/a3ca0724d5fb4693a66ff7b7f7bd4602
Requested by: @streamer45


Staging: Open in Devin

Update documentation across the repo to reflect that basic video
support (VP9 encode/decode, compositor, WebM muxing) is now
implemented on the video branch, rather than being future/roadmap-only.

Changes:
- README.md: update tagline, screenshot caption, add video compositing
  use case, update media focus from audio-first to audio+video
- ROADMAP.md: strike through shipped video items (packet types, VP9
  baseline, compositor MVP)
- docs landing page: update hero tagline, who-is-this-for, add video
  compositing to what-you-can-build
- docs architecture overview: add video to built-in node categories
- docs performance guide: update audio->audio/video, add VideoFramePool
  mention
- crates/nodes README: add video::* to node implementation list

Signed-off-by: StreamKit Devin <devin@streamkit.dev>
Co-Authored-By: Claudio Costa <cstcld91@gmail.com>
@staging-devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@streamer45 streamer45 merged commit ef2c192 into video Mar 15, 2026
1 check was pending
@streamer45 streamer45 deleted the devin/1773569202-docs-video-update branch March 15, 2026 10:08
Copy link
Copy Markdown
Contributor Author

@staging-devin-ai-integration staging-devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Staging: Open in Devin
Debug

Playground

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants