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

Documentation Missing the Most Basic Info: How to Get Started #2627

Open
jwalkerinterpres opened this issue Aug 1, 2024 · 0 comments
Open

Comments

@jwalkerinterpres
Copy link

jwalkerinterpres commented Aug 1, 2024

Describe/explain the bug
in the documentation for virtually every Javascript library in existence (even ones with just a GitHub page) there is some sort of "Getting Started" page/section which covers ... well, how to get started.

That page contains the npm install command (which is important, because as an ousider you don't know if the package is named nivo or nivojs or @nvio, or some other weird name).

EDIT: I finally found this part here. I would still argue that it belongs in the site's documentation though.

It also contains an extremely basic example for a "Hello World" (in this case, an extremely minimal line chart would be appropriate). This is valuable because when you're using a new library it's important to "wire it up" correctly, and if you've never seen the library used before that's challenging.

To Reproduce

Steps to reproduce the behavior:

Expected behavior
Unless you want to be unwelcoming to new library users, the expectation is that this page will exist.

NOTE: The site does have great examples in each chart's page. But again, as someone trying to use the library for the first time, a "Getting Started" page with the info I mentioned would be very helpful.

Desktop (please complete the following information):
Irrelevant

Additional context
This doesn't have to be anything big or fancy; you can probably support new adopters a ton better with < hour of effort creating this page.

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

No branches or pull requests

1 participant