jvector icon indicating copy to clipboard operation
jvector copied to clipboard

General documentation and API index

Open bahmanm opened this issue 2 years ago • 3 comments

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.

bahmanm avatar Oct 05 '23 09:10 bahmanm

Does the new README help?

jbellis avatar May 29 '24 13:05 jbellis

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)

rd-99 avatar Jun 06 '24 15:06 rd-99

Does the new README help?

It certainly is way better. I also love the examples sub-project.

bahmanm avatar Jul 16 '24 23:07 bahmanm