Skip to content

Discussion about the intro video #934

@maximlt

Description

@maximlt

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docdocs, interactive help, auto-completion, etcstatus: discussionDiscussion. Not yet a specific feature/bug. Likely to result in multiple PRs/issues.

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions