API Documentation

[amithkoujalgi]

Hello @langchain4j.

First of all, thank you for bringing langchain to the Java world. Its amazing! 🤩

I was wondering if there's a comprehensive API documentation available somewhere for someone to get started with basics (including setup, how and why langchain4j is used, etc) and then progressively navigate through the documentation to explore more and try more advanced stuff.

If its not already available, I was thinking if I could setup a skeleton structure for the documentation using docusaurus.

I was thinking that we can have well structured comprehensive API documentation such as this.

Let me know what you think. Thanks!

[LizeRaes]

Hi @amithkoujalgi ,
Thank you for your interest and the Ollama4j reference!
We were planning to continue extending this langchain4j documentation website in #152
I wrote an outline for adding code examples and integration lists, I think it would be a great spot to combine this with proper API documentation.

The last days @crutcher has been adding a lot of javadoc as well (thank you so much @crutcher !), let's integrate that there too.

[LizeRaes]

The docusaurus features sound very interesting, if we want to keep the documentation website up to date, we indeed better have a lot of automated updates coming from the repo 👌
Also, the fact that you already did that awesome documentation for Ollama is very tempting!
Let's however wait some more days to see if @clun reacts in #152 since he has already spent effort on it.
I will reach out soon :)

[amithkoujalgi]

Alright @LizeRaes.🙂 Thanks for the update!

[LizeRaes]

Hi @amithkoujalgi , since we got no reply from @clun, we decided to move forward with your proposed docusaurus solution. Are you still up for setting up the skeleton? Would be greatly appreciated!
I'm drafting the sitemap in this google docs - if you could already set this up, I will help adding the missing parts afterwards.
Feel free to create a directory langchain4j/doc for the sources :)
Thank you so much!

[amithkoujalgi]

Hello @LizeRaes. I'm glad to hear that you considered the solution I proposed! 🤩

Absolutely, I'm excited to get started on setting up the Docusaurus skeleton for langchain4j!

I'll dive into the Google Docs sitemap you've shared and begin the initial setup. If you have any specific preferences or additional details you'd like to include, feel free to let me know.

I'll fork and create a PR with the initial structure, and once the initial structure is in place, you can review it to see if there's something missing. Looking forward to collaborating on this!

Also, I'd like to know what are your thoughts on hosting the docs? Would you be considering using GitHub pages or Vercel (free for open-soure projects) or something along those lines?

I'd personally prefer GitHub pages as is GitHub's own solution that can be enabled for free for public (open-source) projects and usually is meant to host static pages such as documentation/javadoc etc. Looking forward to know your opinion on this.

[amithkoujalgi]

I've created a PR for this @LizeRaes.
Please have a look and do let me know what you think. 🙂
Thanks!