You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Search for the section; none exists (the npm install command does, but there's no basic example)
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.
The text was updated successfully, but these errors were encountered:
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
ornivojs
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:
npm install
command does, but there's no basic example)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.
The text was updated successfully, but these errors were encountered: