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.

Sign up for GitHub

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

Jump to bottom

embed asciinema examples within documentation #6222

Open
bjlittle opened this issue Nov 7, 2024 · 2 comments
Open

embed asciinema examples within documentation #6222

bjlittle opened this issue Nov 7, 2024 · 2 comments
Labels
Type: Documentation

Comments

@bjlittle
Copy link
Member

bjlittle commented Nov 7, 2024 •
edited
Loading

📚 Documentation

Just floating the idea of using sphinxcontrib.asciinema sparingly within the documentation to showcase certain features and/or behaviours?

If appropriate, perhaps even consider using it within the whatsnew to showcase something to the community that we're particularly excited or proud about?

Thoughts? 🤔
@tkknight
Copy link
Contributor

tkknight commented Nov 7, 2024

I think this would be great. Also committing to publishing the cast files (to their server and not hosted locally) would be good too imho.

@trexfeathers
Copy link
Contributor

Sounds fun! Could either of you give an example?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Type: Documentation
Projects
🚴 Peloton
Status: No status
Milestone
No milestone
Development

No branches or pull requests
3 participants
@bjlittle @tkknight @trexfeathers