Skip to content

Website doesn't convey crucial info  #17

@elektronik2k5

Description

@elektronik2k5

Hi! Interesting project. I'm intrigued by the API here cause I haven't seen anything alike in react packages. It is rather unusual and I see the potential in such an approach.

Anyways, the issue is about the website: https://react-call.desko.dev/. It is a demo, which is great (since most packages fail to even ship a demo). But it fails to mention the problem which this project solves. In other words: what is it even good for?

Here's the flow for someone who lands on the website (like me, after someone sent me the link):

  1. See cool demo, play with it. Nice, got some potential, just cause there is a demo and is isn't shit. But what does it actually do? Does it differ from any other modal package? No idea. Typically, at this stage I'd give up. However, the demo quality convinced me to investigate further. Click the barely visible, small See docs link in bottom right corner of giant title. ->
  2. New tab on github project (instead of direct link to readme) - all I see is the files and directories. Scroll down ->
  3. Go past project files, title + subtitle + npm i ... + link to demo, features ->
  4. Finally! The pattern provides an example to what's it good for and Use cases expand on that. Next, I see the well annotated Usage block. Problem description and how this package tries to solve it.

I suggest changing the demo page and readme to first cover the pattern, use cases and usage, proceed to demo and follow up with the rest of the documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions