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

Update and expand project documentation #6

Open
Were-Woof opened this issue Oct 11, 2024 · 0 comments
Open

Update and expand project documentation #6

Were-Woof opened this issue Oct 11, 2024 · 0 comments

Comments

@Were-Woof
Copy link
Contributor

While there is sphinx documentation for the project, along with a quickstarter guide, the project is missing documentation/references for a few key areas.

The quickstarter guide is outdated. While it was originally correct, Wrapper has been renamed to Client, meaning that the example code will not work.
image
image
There is also no reference to AsyncClient within the README. While AsyncClient has no major usage differences to Client, the guide would benefit from including both to ensure that users are aware of both of them.

There are also no guides for contributing to the project. While the project does not have a large amount of requirements or a large amount of setup to begin development, it would make development easier to set a standard for issue format, linting and coding/documentation styling.

To resolve this, I would like to establish contribution standards, including linting, an issue template and coding/documentation stylings. I would also like to update the quickstarter guide to target the current version of the project.

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

No branches or pull requests

1 participant