Skip to content
This repository has been archived by the owner on Dec 21, 2021. It is now read-only.

Auto-generate Client API Docs #221

Merged
merged 4 commits into from
Mar 15, 2021
Merged

Auto-generate Client API Docs #221

merged 4 commits into from
Mar 15, 2021

Conversation

timoxley
Copy link
Contributor

@timoxley timoxley commented Mar 13, 2021

Current auto-generated docs only include DataUnion docs.
This PR includes auto-generated docs for the rest of top-level client APIs.
Also added some minor annotation changes to expose some things which shouldn't be @internal e.g. client.resend, and started giving descriptions to config properties.
Some classes and methods have the @category Important annotation in order to highlight them in the docs.

This PR also includes updated DU docs, due to changes in #220


New pages look something like this:

Entry

image

StreamrClient

image

Config

image

@timoxley timoxley requested review from fonty1 and teogeb March 13, 2021 16:56
@timoxley timoxley mentioned this pull request Mar 13, 2021
Copy link
Member

@fonty1 fonty1 left a comment

Choose a reason for hiding this comment

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

Excellent! LGTM, I suppose the GitHub Pages will update every time the /docs folder is updated on the master branch?

@timoxley
Copy link
Contributor Author

I suppose the GitHub Pages will update every time the /docs folder is updated on the master branch?

Correct 👍

Copy link
Contributor

@jtakalai jtakalai left a comment

Choose a reason for hiding this comment

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

LGTM, though maybe should docs be generated and published as a Github Action, instead of pushed to source control?

@timoxley
Copy link
Contributor Author

though maybe should docs be generated and published as a Github Action, instead of pushed to source control?

Good point, that would be better.

@timoxley timoxley merged commit 0588d89 into master Mar 15, 2021
@timoxley timoxley deleted the full-client-docs branch March 15, 2021 15:00
@timoxley
Copy link
Contributor Author

Going to add the docs in a new workflow. Merging so Actions picks up the new workflow.

@timoxley
Copy link
Contributor Author

Hm, Actions UI wasn't showing the new workflow, but now it is. ok. Cool. Will open new PR to iterate on that.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants