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

Where is the documentation? #2025

Closed
gweinfurther opened this issue Apr 7, 2020 · 1 comment
Closed

Where is the documentation? #2025

gweinfurther opened this issue Apr 7, 2020 · 1 comment

Comments

@gweinfurther
Copy link

I can find no documentation. There's nothing in the wiki or the API documentation. What exists are circular references, e.g., "go here for the documentation, and here says to go there for documentation.

Examples are good, but they do not offer a complete picture of everything that is possible.

@Synchro
Copy link
Member

Synchro commented Apr 7, 2020

I don't know what you mean. The readme is a good starting point, the generated API documentation covers every single property and method, the example code shows how to use them, and the wiki contains tutorials, an extensive troubleshooting information, and focused articles on specific subjects. I don't know what else you're looking for, but you're very welcome to write whatever it is and submit a PR.

@Synchro Synchro closed this as completed Apr 7, 2020
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