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

General documentation and API index #114

Open
bahmanm opened this issue Oct 5, 2023 · 3 comments
Open

General documentation and API index #114

bahmanm opened this issue Oct 5, 2023 · 3 comments

Comments

@bahmanm
Copy link

bahmanm commented Oct 5, 2023

First off, great work!


It'd be very helpful if there were general documentation which helped map the theory and concepts to the class hierarchy or the main facades.

That may be augmented w/ potentially more examples and definitely an API index to browse.

@jbellis
Copy link
Owner

jbellis commented May 29, 2024

Does the new README help?

@rd-99
Copy link
Contributor

rd-99 commented Jun 6, 2024

First off, great work!

It'd be very helpful if there were general documentation which helped map the theory and concepts to the class hierarchy or the main facades.

That may be augmented w/ potentially more examples and definitely an API index to browse.

https://speakerdeck.com/michaelisvy/spring-petclinic-sample-application - Iam guessing something like this, but for a large project it will need multiple contributors(will also help in long-term for oss contributers)

@bahmanm
Copy link
Author

bahmanm commented Jul 16, 2024

Does the new README help?

It certainly is way better. I also love the examples sub-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

3 participants