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

tsdoc comments and readme for @polywrap/client-js #1333

Merged
merged 2 commits into from
Oct 18, 2022

Conversation

krisbitney
Copy link
Contributor

@krisbitney krisbitney commented Oct 14, 2022

This PR adds comments in the TSDoc format to public methods of the JS PolywrapClient, and adds a readme with full reference documentation based on the comments.

The benefits of this approach:

  1. The "Reference" section of the readme is easy to create after copy/pasting the .d.ts file, which contains the comments. Although I did this part manually, it could be automated with a script.
  2. We can promote a process wherein developers are expected to update or add tsdoc comments when modifying javascript libraries.

This makes it easy for us to keep reference documentation up to date.

Related:
Documentation Roadmap (hackmd)
Summary of Documentation Roadmap (discord)

Closes polywrap/documentation#206

Copy link
Contributor

@dOrgJelli dOrgJelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome, I'm all for this approach! Having generated reference documentation to live below the hand-authored example snippets sounds great.

I know that you currently have to copy the generated docs manually now, but this can be its own "snippet" that's embedded using the CLI tool we're going to publish (see here: polywrap/documentation#232).

@krisbitney krisbitney marked this pull request as ready for review October 16, 2022 05:18
@dOrgJelli dOrgJelli merged commit ada3a83 into origin-dev Oct 18, 2022
@dOrgJelli dOrgJelli deleted the client-js-readme branch April 10, 2023 17:05
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

Successfully merging this pull request may close these issues.

2 participants