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

Documentation needs expansion #6

Open
nickelpro opened this issue Aug 15, 2020 · 0 comments
Open

Documentation needs expansion #6

nickelpro opened this issue Aug 15, 2020 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@nickelpro
Copy link
Member

The example plugin is a good stop gap, but we desperately need documentation for every default plugin and interface, as well as the SimpleClient, and how to build your own client.

These things move fast, so there's some weight to not getting overly invested in docs right now. Still, it is easier to update docs than it is to write them whole-cloth for a late stage project. Skeleton work now will pay off later.

Not going to assign this as an August issue, but sooner rather than later I'm going to need to spend a couple days writing comprehensive on-boarding docs.

@nickelpro nickelpro added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 15, 2020
@nickelpro nickelpro self-assigned this Aug 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant