Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: README and docs update #389

Merged
merged 7 commits into from
Dec 13, 2022
Merged

Conversation

dylanjha
Copy link
Collaborator

@dylanjha dylanjha commented Dec 8, 2022

  • slimmed down README to remove a lot of the duplication that's already in docs
  • added 'Audio player' Guide with a simple audio example
  • added missing attribute docs for audio on Media controller
  • added "In the wild" to Learn More section in nav to show places where Media Chrome is used in the wild
  • added "Basics" > "Media slot" doc with details about the media slot, media element and how that works
  • added "Media Clip Selector" under components

-[x] slimmed down README to remove a lot of the duplication that's already
  in docs
-[x] added 'Audio player' Guide with a simple audio example
-[x] added missing attribute docs for `audio` on Media controller
-[x] added "In the wild" to Learn More section in nav to show places where Media Chrome is used in the wild
-[x] added "Basics" > "Media slot" doc with details about the media slot, media element and how that works
-[x] added "Media Clip Selector" under components
@vercel
Copy link

vercel bot commented Dec 8, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
media-chrome ✅ Ready (Inspect) Visit Preview Dec 13, 2022 at 7:24PM (UTC)
media-chrome-docs ✅ Ready (Inspect) Visit Preview Dec 13, 2022 at 7:24PM (UTC)

README.md Outdated Show resolved Hide resolved
docs/src/config.ts Outdated Show resolved Hide resolved
docs/src/pages/en/audio-player.md Outdated Show resolved Hide resolved
docs/src/pages/en/get-started.md Outdated Show resolved Hide resolved
docs/src/pages/en/in-the-wild.md Outdated Show resolved Hide resolved
docs/src/pages/en/media-clip-selector.md Outdated Show resolved Hide resolved
docs/src/pages/en/media-clip-selector.md Outdated Show resolved Hide resolved
docs/src/pages/en/media-clip-selector.md Outdated Show resolved Hide resolved
docs/src/pages/en/media-slot.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@heff heff left a comment

Choose a reason for hiding this comment

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

👍

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@luwes
Copy link
Contributor

luwes commented Dec 10, 2022

This is great!

Could the media-clip-selector also be a live example like the other controls? the screenshot doesn't look too good
https://media-chrome-docs-git-fork-dylanjha-dj-docs-updates-mux.vercel.app/en/media-clip-selector

@luwes
Copy link
Contributor

luwes commented Dec 10, 2022

The audio player page should also be a live example I think or have the codesandbox inline.

The current link navigates users away from the docs site
https://media-chrome-docs-git-fork-dylanjha-dj-docs-updates-mux.vercel.app/en/audio-player

@dylanjha
Copy link
Collaborator Author

Thanks @luwes -- I split out the clip selector guide into another branch because it wasn't working quite right on the docs page. The thumbnail container was positioned incorrectly. Might be a bug with the clip selector itself, will have to dig into that one.

Good call on the other improvements though, better to actually render the real web component instead of doing screenshots!

@heff I put the audio example back

@davekiss
Copy link
Collaborator

This seems to 404 as well, maybe we need a rebuild?

https://media-chrome-docs-git-fork-dylanjha-dj-docs-updates-mux.vercel.app/en/media-clip-selector

@dylanjha dylanjha merged commit 0b930b0 into muxinc:main Dec 13, 2022
@dylanjha dylanjha deleted the dj/docs-updates branch December 13, 2022 19:34
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.

5 participants