Improve the documentation with code examples at https://csv.js.org
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 4.3k
- Forks
- 299
- Avg merge
- 16h 19m
- Merged PRs (30d)
- 1
Description
I find your documentation website really hard to use.
For example, navigating to https://csv.js.org/parse/ I would expect to find examples of how the parse package is used rather than just how it is installed. Due to the poor left navigation menu it is unclear that I need to click on "API", then on my preferred usage method (e.g. "Stream") before I get to see any code. A short example of code should either be shown there and then (like most NPM packages are), or perhaps in this case it would be better to just give the API links from the front page so that people can get started quickly.
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 at https://csv.js.org/parse/ and inspect the API and Stream navigation described in the issue. Add short parse usage examples or clearer API links on the relevant documentation pages, then verify that visitors can reach a code example from the front page or parse page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, nodejs
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100