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

It is confusing to get the docs of the Latest Release #540

Closed
shresthagrawal opened this issue Jan 28, 2020 · 1 comment
Closed

It is confusing to get the docs of the Latest Release #540

shresthagrawal opened this issue Jan 28, 2020 · 1 comment

Comments

@shresthagrawal
Copy link
Contributor

Enhancement

Severity:

Low

Description:

The doc in the master branch consist of changed API also from the pre-release. This might be confusing for a dev to find the write documentation.

For eg: it took me some time to realise createLibp2p() is replaced with create() in the pre release. Using the latest release from the npm I would still use the createLibp2p() but the master doc says to use the create().

Possible Solution

In the readme add the following line

The doc linked in the master branch are for pre-release.
If you are looking for the docs for the latest release, then (head here)[link to npm docs]

Thanks @vasa-develop

@jacobheun
Copy link
Contributor

Fixed in #541

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

2 participants