web3-react icon indicating copy to clipboard operation
web3-react copied to clipboard

Document things

Open Jakkc opened this issue 2 years ago • 2 comments

Pretty much the entire eth ecosystem relies on this library and the docs are non-existent.

Today I spent hours working out why the coinbase connector wouldn't work out of the box.

Turns out you have to install a bunch of peer dependencies at the root level of your repo.

Would it have been so difficult for you guys to document this? (yeah I understand it's casually thrown in the readme, but that's easy to miss once you've worked with this library for an extended period of time. Put it on a dedicated docs page)

Put a gitcoin bounty up or something. No docs with such an important library is not acceptable.

Jakkc avatar Jul 31 '23 13:07 Jakkc

I started docs in my PR, I guess it was too big of a PR or whatever and they declined it and took stuff I did and made their own PRs. For anyone he needs a quick overview or even how to upgrade from v6 to v8 can go to my fork. After I get done with my project I'll break out features and do little PRs. My PR and my Repo

niZmosis avatar Jul 31 '23 21:07 niZmosis

I guess it was too big of a PR or whatever and they declined it

It's a pretty big PR lmao. But agree some docs are necessary and happy to contribute like I'm sure many others are. Easiest way to find information is look through the .d.ts files in node_modules... Throughout the day I've made note of things that I would have appreciated docs on maybe we could collate somewhere? @Jakkc and @niZmosis ?

dospore avatar Aug 29 '23 19:08 dospore