This repository was archived by the owner on Aug 24, 2023. It is now read-only.
This repository was archived by the owner on Aug 24, 2023. It is now read-only.
Docs: Add documentation tags and examples for usage #30
Description
we should tag methods, classes and interfaces to generate docs to inform consumers about usage.
There is useful information here that isn't in the `@libp2p/prometheus-metrics` docs.
Can you please PR that repo with the information that's been removed here.
You can use the `@packageDocumentation` tag ([example](https://github.com/libp2p/js-libp2p/blob/master/src/pnet/index.ts#L1C1-L23) - [output](https://libp2p.github.io/js-libp2p/modules/pnet.html)) to get general docs to appear on a given page, and the `@example` tag to annotate individual methods, classes or interfaces with code that people can copy/paste to get started.
Originally posted by @achingbrain in libp2p/js-libp2p#1505 (comment)