carsonfarmer / libp2p-bundle

Basic libp2p bundle with settings that match js-ipfs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

feat: Better API docs

carsonfarmer opened this issue · comments

commented

Feature Request

Describe the Feature Request

We need better API docs. Folks might actually want to use this, and it'd be nice to have auto-generated API docs that leverage the types correctly. Maybe typedoc would work? I'd like to just create some really simple markdown API docs...

Describe Preferred Solution

Some really simple, lightweight docs solution. Something like auto-generated markdown docs, or a really simple docs deploy setup if we need to.

Describe Alternatives

I don't really wanna do a full blown docs site. There's only like two functions here. Let's keep it simple!