Documentation is not very helpful

[pstephenwille]

I'm not finding the docs very helpful at all. So far they seem to be composed of the Ether's code schema. For example, I was looking for list of default events but not a single one is listed on this page - https://docs.ethers.org/v6/api/utils/events/

The typing info is moderately helpful but hardly worth a web page visit. There must be a better way. What about a list of default values, or common values; top of the bell curve use cases?

[ricmoo]

Heya!

Thanks for the feedback. There documentation is absolutely something I'd love to have more fleshed out, and any help is appreciated, even if it is just a list of things that are missing (or missing-ish). I am hoping to find someone to help out with the documentation, and plan to migrate some of the primer docs from v5.

The main reason I haven't worried about primer docs as much is that the EF now has meaningful docs, in 2018 when I began Ethers, there was very little, which is why I focused more on Ethereum-basics. But I am absolutely fine adding more; suggestions welcome. :)

The Provider Events are included in the provider docs, but it likely makes sense to backlink from the events docs too.

I am planning a slight re-write of Flatworm (the documentation engine) to add a custom _signature fragment instead of relying on _header, then instead of having TypeScript as a dependency of Flatworm, Flatworm can go back to dependency-free, and a separate script will read a TypeScript folder and dump out the relevant Flatworm source. Anyways, that's prolly more than you care to know, but I only mention it because adding a default parameter value makes total sense to add to the signature parser, instead of having to include default values in the jsdocs body.

Documentation might also be a great place to start a bountres program I've been planning. :)

[ghost]

I totally agree. The reason for this is partly related to the UI. It would be better if the documentation was moved to Nextra.

[ricmoo]

Why? What would nextra offer?