Skip to content

docs(site): update architecture naming and add concept pages#328

Closed
heff wants to merge 4 commits intomainfrom
docs/align-skill-output-locations
Closed

docs(site): update architecture naming and add concept pages#328
heff wants to merge 4 commits intomainfrom
docs/align-skill-output-locations

Conversation

@heff
Copy link
Copy Markdown
Member

@heff heff commented Jan 24, 2026

Summary

  • Update three-pillar architecture framing: Player (state
    coordination root), Media, UI/Skins
  • Add new naming conventions for HTML elements (object-last
    pattern)
  • Add Design Notes section with architectural rationale
  • Add new concept pages: features.mdx, media.mdx, presets.mdx
  • Update presets to use function call syntax:
    presets.website()
  • Mark news and streamingApp presets as (planned)
  • Add createPlayer() examples for HTML custom
    configurations
  • Update YouTube/Vimeo media as available

Key naming patterns

Pattern Example
{usecase}-{mediatype}-player website-video-player

|
| {usecase}-{style}-{mediatype}-skin |
website-frosted-video-skin |
| {impl}-{mediatype} | hls-video, youtube-video |
| media-{action}-{object} | media-play-button |

Test plan

  • Run pnpm dev:site and verify pages render
  • Check cross-links between concept pages work
  • Review code examples for consistency

🤖 Generated with Claude
Code

@vercel
Copy link
Copy Markdown

vercel Bot commented Jan 24, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
vjs-10-website Ready Ready Preview, Comment Jan 29, 2026 1:04am

Request Review

heff and others added 4 commits January 28, 2026 16:11
- Update three-pillar framing: Player (state root), Media, UI/Skins
- Add new naming conventions: website-video-player, hls-video, media-play-button
- Add Design Notes section with architectural rationale
- Add features.mdx documenting feature lifecycle and options
- Add media.mdx and presets.mdx concept pages
- Update presets to use function syntax: presets.website()
- Mark news and streamingApp presets as planned
- Add createPlayer() examples for HTML custom configurations
- Update YouTube/Vimeo as available, rename live to interactiveLive

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@heff heff force-pushed the docs/align-skill-output-locations branch from a6d6528 to 0f2fc11 Compare January 29, 2026 01:02
@heff heff closed this Mar 7, 2026
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.

UI components guide Media sources guide Skins guide Presets & providers guide Architecture guide

1 participant