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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
vajahath opened this issue Apr 24, 2024 · 1 comment

Comments

@vajahath
Copy link

vajahath commented Apr 24, 2024

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:

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
Copy link
Member

wdavidw commented Apr 24, 2024

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).

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

2 participants