Skip to content

JS client has no documentation #86

Description

@krisbitney

From a recent paid user study:

The readme of @polywrap/client-js has no docs, it leads to the package repository polywrap/client-javascript, which has a link “Documentation” that leads to https://docs.polywrap.io/ which has a link Clients that leads back to polywrap/client-javascript repository.

The JS client used to have automatically-generated reference documentation in its readme, but it looks like it was removed at some point and was never replaced.

JS client readme: https://github.com/polywrap/javascript-client

The JS client should have more documentation.

  • What packages are in the JS client repo? Which do I need?
  • What methods are available in the client?
  • Which important plugins are available and where can I find them?
  • What is the best way to use the client?
  • etc.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions