Packages on npm are missing documentation

Question

omitar opened this issue 5 years ago · comments

"Unable to find a readme for @oasislabs/client@1.0.0-rc.17"

Keywords
none

Also link to GitHub is missing.

Armani Ferrante · Answer 1 · Tue Sep 10 2019 00:30:11 GMT+0800 (China Standard Time)

The solution here is to add separate READMEs for each subpackage.

omitar · Answer 2 · Tue Sep 10 2019 00:50:54 GMT+0800 (China Standard Time)

It can also be something very basic, just linking to the main documentation.

GitHub link is also very important.

Armani Ferrante · Answer 3 · Thu Sep 12 2019 05:57:56 GMT+0800 (China Standard Time)

Addressed by #285. READMEs will be on NPM next time we publish.

omitar · Answer 4 · Thu Sep 12 2019 13:27:12 GMT+0800 (China Standard Time)

I think important things reported here are still missing:

Also, the link to main README does not work on NPM.

Armani Ferrante · Answer 5 · Fri Sep 13 2019 00:27:13 GMT+0800 (China Standard Time)

Links worked in github but were broken on NPM (repo paths don't work so I switched to complete urls).

Addressed by #289.

Moving the NPM key words to a separate issue. See #290.