Taking too much energy and patience to navigate and understand the docs site
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 4.3k
- Forks
- 299
- Avg merge
- 16h 19m
- Merged PRs (30d)
- 1
Description
Describe the bug
First, I want to express my appreciation for this amazing library! 🌟 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:
- Example page: https://csv.js.org/stringify/examples/
- Samples folder: https://github.com/adaltas/node-csv/tree/master/packages/csv-stringify/samples
- Test folder: https://github.com/adaltas/node-csv/tree/master/packages/csv-stringify/test
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the npm usage documentation with the csv-stringify example page, samples folder, and test folder linked in the issue. Map where users currently look for examples and identify a consolidated usage guide or API reference. Done means beginners can find representative usage examples without navigating scattered resources.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, nodejs
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100