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: update demo #4350

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
Draft

docs: update demo #4350

wants to merge 10 commits into from

Conversation

hverlin
Copy link
Contributor

@hverlin hverlin commented Feb 9, 2025

  • Update the demo to show that one can install multiple tools:
demo.mp4
  • Add transcript

image

@@ -0,0 +1,90 @@
# Use mise run docs:demo to record this tape

Output demo.gif
Copy link
Contributor

Choose a reason for hiding this comment

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

if the demo.gif is not used you can probably removed it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I can remove it 👍
The other option I was thinking about is to leave the gif in the readme and go to the demo page if one clicks on it ?

Copy link
Contributor

Choose a reason for hiding this comment

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

the mp4 can be paused / resume, it's a huge advantage imo

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I agree. So my idea would be to have the video as .mp4 on the demo page only - while we leave the .gif in the Readme.

The .gif will work everywhere, while the video is not shown in some markdown renderer. If the user tries to click on the .gif to pause it, then it will send them to the demo page where they can see the transcript + play/pause the video. I think this will also avoid having to host it through GitHub 🤔

Choose a reason for hiding this comment

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

You're right

Copy link
Contributor

Choose a reason for hiding this comment

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

seems to not be used

@hverlin
Copy link
Contributor Author

hverlin commented Feb 16, 2025

@jdx, Given the discussion in #4414, maybe I should update the demo to show mise exec first as well?

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.

3 participants