Skip to content

Create useful documentation for end users #113

@lidel

Description

@lidel

Problem

Users of ipfs-http-client from js-ipfs have docs like this: https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md

Users of kubo-rpc-client have no such resource.
Automatically generated docs only describe constructor

Solution

TBD.

Can we leverage TS to generate docs for every command?
Improve preexisting https://ipfs.github.io/js-kubo-rpc-client/?

Metadata

Metadata

Assignees

No one assigned

    Labels

    P0Critical: Tackled by core team ASAPneed/triageNeeds initial labeling and prioritization

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions