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

Mention examples in docs #54

Open
kevinji opened this issue Feb 24, 2024 · 1 comment
Open

Mention examples in docs #54

kevinji opened this issue Feb 24, 2024 · 1 comment

Comments

@kevinji
Copy link

kevinji commented Feb 24, 2024

The main page of the docs is pretty barebones and doesn't give the primary entry point for using the library (which is new_connection). I didn't realize there was an examples dir until I looked at the repo itself.

Perhaps a simple example could be added to the main docs page, plus a link to the examples dir for more examples?

@daniel-noland
Copy link
Contributor

This is a very good point. I can work on getting some basic docs in place.

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

2 participants