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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document things #869

Open
Jakkc opened this issue Jul 31, 2023 · 2 comments
Open

Document things #869

Jakkc opened this issue Jul 31, 2023 · 2 comments

Comments

@Jakkc
Copy link

Jakkc commented Jul 31, 2023

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.

@niZmosis
Copy link

niZmosis commented Jul 31, 2023

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

@dospore
Copy link

dospore commented Aug 29, 2023

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 ?

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

3 participants