adaltas / node-csv

Full featured CSV parser with simple api and tested against large datasets.
https://csv.js.org
MIT License
4.06k stars 268 forks source link

Taking too much energy and patience to navigate and understand the docs site #427

Open vajahath opened 7 months ago

vajahath commented 7 months ago

Describe the bug

First, I want to express my appreciation for this amazing library! :star2: The browser and ESM support, along with the features and ongoing maintenance, are fantastic.

I noticed the usage documentation on npm could be more comprehensive.

For example: In my search for guidance, I came across the csv-stringify package and its documentation at link: https://csv.js.org/stringify/. While I found the "Additional Help" section with example folders, it contained three separate references:

While I appreciate having multiple resources, having them scattered across different locations made it a bit confusing to navigate.

This is one example. The current structure may make it difficult for users to find a good usage example within a few minutes.

I believe a consolidated and easily accessible usage guide or API reference would be incredibly helpful, especially for beginners like myself.

wdavidw commented 7 months ago

While you are 100% right on the difficulty to traverse the documentation, I haven't come up yet with a better organisation. Tests are what they are, unit tests. the sample directory gathers all the code example from the documentation (the examples pages like the one you mentioned as well as the options pages).