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

Discussion about the intro video #934

Open
maximlt opened this issue Apr 6, 2024 · 1 comment
Open

Discussion about the intro video #934

maximlt opened this issue Apr 6, 2024 · 1 comment
Labels
doc docs, interactive help, auto-completion, etc status: discussion Discussion. Not yet a specific feature/bug. Likely to result in multiple PRs/issues.

Comments

@maximlt
Copy link
Member

maximlt commented Apr 6, 2024

Fixing #932, I noticed that the link to download the Promo notebook on which is based the intro video was broken (https://tinyurl.com/parampromo). The notebook links to an image in docs/assets, link that is likely to be broken too.

Beyond these issues, the video, even if it's nice, is at this stage a bit outdated (no bind, rx, HTML repr, etc.). I also have to say that as someone who has looked at many websites of Python packages, I feel that having an intro video for a package like Param is unexpected (I don't think I would watch it, to be honest). I would instead expect code snippets and a bullet list of features, that help me to quickly grasp what the library offers. With links to sections of interest to dig further. See this for instance https://docs.pydantic.dev/latest/. I would by the way expect the same thing on the README. So my preference would be to replace the video in favor of that kind of content. What do others think about it? I'm not super happy suggesting that we get rid of something that probably needed a lot of work to create, at the same time, it's also difficult to maintain over time.

@maximlt maximlt added doc docs, interactive help, auto-completion, etc status: discussion Discussion. Not yet a specific feature/bug. Likely to result in multiple PRs/issues. labels Apr 6, 2024
@MarcSkovMadsen
Copy link
Collaborator

Sounds good to me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc docs, interactive help, auto-completion, etc status: discussion Discussion. Not yet a specific feature/bug. Likely to result in multiple PRs/issues.
Projects
None yet
Development

No branches or pull requests

2 participants