Commit Graph

20 Commits

Author SHA1 Message Date
LangChain4j 27a14fcbe8 docu: added links to the documentation chatbot 2025-01-11 19:35:51 +01:00
LangChain4j 0c058ae5c2 docu: added links to the documentation chatbot 2025-01-11 19:12:23 +01:00
LangChain4j e7763cc91d docu: rearranged links 2024-11-08 15:28:32 +01:00
LangChain4j fbf221e711 docu: collect page visit stats 2024-07-18 12:52:10 +02:00
Ruslan 038f24def4
Add docusaurus-lunr-search plugin (#1221)
## Issue
[https://github.com/langchain4j/langchain4j/issues/1219](https://github.com/langchain4j/langchain4j/issues/1219)


## Change
Added the `docusaurus-lunr-search` plugin.

It may seem that for search feature we would need a server. But nothing
stops us from passing that logic to the client)

So, if the index for pages is not too big, we will delegate the search
functionality to client. That's what this plugin does (I think).

It works with `npm run serve`, but I couldn't test it with just opening
the `index.html` file.

Oh, I'm sorry, my editor autoformatted the file)

## General checklist
<!-- Please double-check the following points and mark them like this:
[X] -->
- [x] There are no breaking changes
- [ ] I have added unit and integration tests for my change
- [ ] I have manually run all the unit and integration tests in the
[core](https://github.com/langchain4j/langchain4j/tree/main/langchain4j-core)
and
[main](https://github.com/langchain4j/langchain4j/tree/main/langchain4j)
modules, and they are all green
- [ ] I have manually run all the unit and integration tests in the
module I have added/changed, and they are all green
<!-- Before adding documentation and example(s) (below), please wait
until the PR is reviewed and approved. -->
- [ ] I have added/updated the
[documentation](https://github.com/langchain4j/langchain4j/tree/main/docs/docs)
- [ ] I have added an example in the [examples
repo](https://github.com/langchain4j/langchain4j-examples) (only for
"big" features)
2024-07-03 09:58:56 +02:00
LangChain4j 200522f558 docu: links 2024-03-04 14:16:01 +01:00
LangChain4j 7f83ae0fb8 docu: links 2024-03-04 14:13:23 +01:00
LangChain4j 1fb05b0b8f docu: links 2024-03-04 13:49:03 +01:00
LangChain4j bc2e72da2a docu: links 2024-03-04 13:45:48 +01:00
LangChain4j 5bd2e84d39 docu: useful materials, removed blog 2024-03-04 13:40:31 +01:00
Amith Koujalgi ae662f905d
Docs: Updated the redundant base route from `/docs` to `/` (#655)
The redundant base route `/docs` has been updated to `/`. Also, all the
links used in the docs markdown files have been updated accordingly.
Please verify if everything looks fine.

Thanks!
2024-02-22 15:21:09 +01:00
LangChain4j 6e9e3df18b updated links to new documentation domain 2024-02-21 14:47:45 +01:00
LangChain4j 20ca3dbe02 docu: updated baseUrl 2024-02-21 14:39:13 +01:00
LangChain4j 7d54651f19 Docu: fixes 2024-02-08 09:22:29 +01:00
Amith Koujalgi 31f0da6e94
Docs updates (#599)
- Updated docs GH workflow to build and publish javadoc alongside of
docs directory. This would make the docs available at
https://langchain4j.github.io/langchain4j and javadoc at
https://langchain4j.github.io/langchain4j/apidocs/index.html
- Updated javadoc build command in docs GH workflow to do a full project
build (that includes all modules and no exclusions).
- Updated javadoc build in docs GH workflow to run with Java 21 version.

This is in reference to
https://github.com/langchain4j/langchain4j/discussions/596

---------

Co-authored-by: Lize Raes <49833622+LizeRaes@users.noreply.github.com>
2024-02-06 11:13:41 +01:00
Lize Raes 88153721aa
action to build and publish javadoc to pages (#504)
Adds the following:

 * add maven plugin for generating javadoc 
 * action to build and publish javadoc to pages
 * update javadoc link in docusaurus
2024-01-12 12:50:44 +01:00
Amith Koujalgi aba5eeb925
Docu logos and domain (#503)
@LizeRaes Updated the images for the docs home page 🙂

Just had to convert the PNGs into SVGs as the `Svg` tag takes only image
as SVG.

---------

Co-authored-by: LizeRaes <49833622+LizeRaes@users.noreply.github.com>
2024-01-11 20:37:16 +01:00
Amith Koujalgi 7e42166109
Updated Docs (#500)
- Updated subpage 0 to `Overview` and made it the landing page upon
clicking `Tutorials` from the horizontal/navigation/top bar.
- Set up GitHub action to build and publish the docs to the GitHub pages
on release. [Preview](https://amithkoujalgi.github.io/langchain4j/) of
the docs on GitHub pages. This action/workflow can also be triggered
manually.
- Added content to `/integrations/language-models/ollama`

PS:
If GitHub pages has been enabled in the repository, the repo admin
should be able to run the new GitHub workflow/action in the Actions tab
and after the completion of the workflow, the docs should be available
in the link provided by GitHub (or a specified custom domain).
2024-01-11 09:04:38 +01:00
Lize Raes ec7844719b
set up documentation structure (#473)
suggestion for documentation website layout
2024-01-09 09:47:56 +01:00
Amith Koujalgi a0c63b611e
Added skeleton structure for docs (#458)
Hi @LizeRaes,

In reference to
[this](https://github.com/langchain4j/langchain4j/discussions/429#discussioncomment-8025023),
I've added the skeleton structure for documentation under the `docs`
directory.

I've also updated the `README.md` under the `docs` directory to help in
setting up and running the docs.

It's straightforward to set up and run the docs locally to get a feel
for its appearance.

I've also attached a few screenshots of the pages to get a quick look at
the appearance.

Please have a look and do let me know what you think. Thanks!


**_Sample Images:_**

- Docs: Home/Landing Page

<img width="1792" alt="1"
src="https://github.com/langchain4j/langchain4j/assets/1876165/c2ff1bf3-a412-4d86-be0d-9937936ec533">

- Docs: Inner Page Sample

<img width="1792" alt="2"
src="https://github.com/langchain4j/langchain4j/assets/1876165/9166df41-f16a-4bff-a3ca-145364be475c">

- Docs: Sample Blog

<img width="1792" alt="3"
src="https://github.com/langchain4j/langchain4j/assets/1876165/44dc1e7c-f669-4806-acfe-8fc2c3d2f59b">

Co-authored-by: Amith Koujalgi <amith.koujalgi@razorthink.com>
2024-01-06 04:01:35 +01:00