docs: add integrations

coyang · Jan 8, 2024 · 9b41bd0 · 9b41bd0
1 parent 0ffcd66
commit 9b41bd0
Show file tree

Hide file tree

Showing 31 changed files with 101 additions and 25 deletions.
diff --git a/docs/docs/about/about.md b/docs/docs/about/about.md
@@ -1,80 +1,104 @@
 ---
 title: About Jan
 description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
-keywords: [Jan AI,  Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ]
+keywords:
+  [
+    Jan AI,
+    Jan,
+    ChatGPT alternative,
+    local AI,
+    private AI,
+    conversational AI,
+    no-subscription fee,
+    large language model,
+  ]
 ---
 
-Jan believes in the need for an open source AI ecosystem, and are building the infra and tooling to allow open source AIs to compete on a level playing field with proprietary ones.
+Jan believes in the need for an **open source AI ecosystem**. We are focused on building the infra and tooling to allow open source AIs to compete on a level playing field with proprietary ones.
 
-Jan's long-term vision is to build a cognitive framework for future robots, who are practical, useful assistants for humans and businesses in everyday life. 
+Jan's long-term technical endeavor is to build a cognitive framework for future robots, who are practical, useful assistants for humans and businesses in everyday life.
+
+## Quicklinks
+
+- Core product vision for [Jan Framework](http://localhost:3001/docs/)
+- R&D and model training efforts [Discord](https://discord.gg/9NfUSyzp3y) (via our small data-center which is `free & open to all researchers who lack GPUs`!)
+- Current implementations of Jan Framework: [Jan Desktop](https://jan.ai/), [Nitro](https://nitro.jan.ai/)
 
 ## Why does Jan Exist?
 
 ### Mission
 
-Our mission is to allow humans and businesses to own their AI, with the right to tinker, repair and innovate. 
+Our current mission is to allow humans and businesses to **own their AI, with the right to tinker, repair and innovate**.
+
+:::tip
+Our life-long mission is to **eliminate work - so human can focus on creation, invention, and moral governance over robots**.
+:::
 
 ### Ideal Customer
 
-Our ideal customer is an AI enthusiast or business who has experienced some limitations with OpenAI, and is keen to find open source alternatives. 
+Our ideal customer is an AI enthusiast or business who has experienced some limitations with OpenAI, and is keen to find open source alternatives.
 
 ### Problems
 
-Our ideal customer would use Jan to solve one of these problems. 
+Our ideal customer would use Jan to solve one of these problems.
+
+_Control_
 
-*Control*
 - Control (e.g. preventing vendor lock-in)
 - Stability (e.g. runs predictably every time)
 - Local-use (e.g. for speed, or for airgapped environments)
-
-*Privacy*
+
+_Privacy_
+
 - Data protection (e.g. personal data or company data)
-- Privacy (e.g. nsfw) 
+- Privacy (e.g. nsfw)
+
+_Customizability_
 
-*Customizability*
 - Tinkerability (e.g. ability to change model, experiment)
 - Niche Models (e.g. fine-tuned, domain-specific models that outperform OpenAI)
 
 Sources: [^1] [^2] [^3] [^4]
 
 [^1]: [What are you guys doing that can't be done with ChatGPT?](https://www.reddit.com/r/LocalLLaMA/comments/17mghqr/comment/k7ksti6/?utm_source=share&utm_medium=web2x&context=3)
 [^2]: [What's your main interest in running a local LLM instead of an existing API?](https://www.reddit.com/r/LocalLLaMA/comments/1718a9o/whats_your_main_interest_in_running_a_local_llm/)
-[^3]: [Ask HN: What's the best self-hosted/local alternative to GPT-4?](https://news.ycombinator.com/item?id=36138224) 
+[^3]: [Ask HN: What's the best self-hosted/local alternative to GPT-4?](https://news.ycombinator.com/item?id=36138224)
 [^4]: [LoRAs](https://www.reddit.com/r/LocalLLaMA/comments/17mghqr/comment/k7mdz1i/?utm_source=share&utm_medium=web2x&context=3)
 
 ### Solution
 
-Jan is a seamless user experience that runs on your personal computer, that glues the different pieces of the open source AI ecosystem to provide an alternative to OpenAI's closed platform. 
+Jan is a seamless user experience that runs on your personal computer, that glues the different pieces of the open source AI ecosystem to provide an alternative to OpenAI's closed platform.
 
 - We build a comprehensive, seamless platform that takes care of the technical chores across the stack required to run open source AI
-- We run on top of a local folder of non-proprietary files, that anyone can tinker with (yes, even other apps!) 
+- We run on top of a local folder of non-proprietary files, that anyone can tinker with (yes, even other apps!)
 - We provide open formats for packaging and distributing AI to run reproducibly across devices
 
 ## How Jan Works
 
 ### Open Source
 
-Jan is a startup with an open source business model. We believe in the need for an open source AI ecosystem, and are committed to building it. 
+Jan is a startup with an open source business model. We believe in the need for an open source AI ecosystem, and are committed to building it.
 
-- [Jan: a Personal AI](https://github.com/janhq/jan) (AGPLv3)
+- [Jan Framework](https://github.com/janhq/jan) (AGPLv3)
+- [Jan Desktop Client & Local server](https://jan.ai) (AGPLv3, built on Jan Framework)
 - [Nitro: run Local AI](https://github.com/janhq/nitro) (AGPLv3)
 
 ### Build in Public
 
-We use Github to build in public, and welcome anyone to join in.  
+We use Github to build in public, and welcome anyone to join in.
 
 - [Jan's Kanban](https://github.com/orgs/janhq/projects/5)
 - [Jan's Roadmap](https://github.com/orgs/janhq/projects/5/views/29)
 
 ### Bootstrapped
 
-Jan is currently a bootstrapped startup. We balance technical invention with the search for a sustainable business model. 
+Jan is currently a bootstrapped startup. We balance technical invention with the search for a sustainable business model.
 
-We appreciate any business that can balance growth with cashflow/profitability. 
+We appreciate any business that can balance growth with cashflow/profitability.
 
 ### Remote Team
 
-Jan has a fully-remote team. We are mainly based in the Asia timezone. We use [Discord](https://discord.gg/af6SaTdzpx) and [Github](https://github.com/janhq) to work. 
+Jan has a fully-remote team. We are mainly based in the Asia timezone. We use [Discord](https://discord.gg/af6SaTdzpx) and [Github](https://github.com/janhq) to work.
 
 ## Contact
 
@@ -88,6 +112,6 @@ Drop us a message in our [Discord](https://discord.gg/af6SaTdzpx) and we'll get
 
 ### Careers
 
-Jan has a culture of ownership, independent thought, and lightning fast execution. If you'd like to join us, we have open positions on our [careers page](https://janai.bamboohr.com/careers).   
+Jan has a culture of ownership, independent thought, and lightning fast execution. If you'd like to join us, we have open positions on our [careers page](https://janai.bamboohr.com/careers).
 
 ## Footnotes
diff --git a/docs/docs/docs/README.md → docs/docs/docs/01-README.md b/docs/docs/docs/README.md → docs/docs/docs/01-README.md
@@ -79,7 +79,7 @@ We believe all software applications can be natively supercharged with AI primit
 Including:
 
 - OpenAI Compatible AI [types](https://github.com/janhq/jan/tree/main/core/src/types) and [core extensions](https://github.com/janhq/jan/tree/main/core/src/extensions) to support common functionality like making an inference call.
-- A lightweight, embedded C++ [inference engine/wrapper](https://github.com/janhq/jan/tree/main/extensions/inference-nitro-extension) that's immediately callable from code. _On this, we'd like to appreciate the folks at [llamacpp](https://github.com/ggerganov/llama.cpp) and [TensorRT-LLM](https://github.com/NVIDIA/TensorRT-LLM) for. To which we'll continue to make commits & fixes back upstream._
+- Multiple inference engines through [extensions, integrations & wrappers](https://github.com/janhq/jan/tree/main/extensions/inference-nitro-extension) _On this, we'd like to appreciate the folks at [llamacpp](https://github.com/ggerganov/llama.cpp) and [TensorRT-LLM](https://github.com/NVIDIA/TensorRT-LLM) for. To which we'll continue to make commits & fixes back upstream._
 
 - [Code Entrypoint](https://github.com/janhq/jan/tree/main/core/src/api)
 

diff --git a/docs/docs/docs/02-integrations/README.md b/docs/docs/docs/02-integrations/README.md
@@ -0,0 +1,9 @@
+---
+title: Integrations
+---
+
+Existing and upcoming 3rd party integrations on top of Jan Framework.
+
+From both the core development team, and core contributors.
+
+Suggestions? File an [issue here](https://github.com/janhq/jan/issues)
diff --git a/docs/docs/docs/02-integrations/langchain.md b/docs/docs/docs/02-integrations/langchain.md
@@ -0,0 +1,7 @@
+---
+title: Langchain
+---
+
+:::caution
+WIP
+:::
diff --git a/docs/docs/docs/02-integrations/llamacpp.md b/docs/docs/docs/02-integrations/llamacpp.md
@@ -0,0 +1,9 @@
+---
+title: LlamaCPP
+---
+
+## Quicklinks
+
+- Jan Framework [Extension Code](https://github.com/janhq/jan/tree/main/extensions/inference-nitro-extension)
+- ggerganov/llama.pp [Source URL](https://github.com/ggerganov/llama.cpp)
+- [Productized Wrapper](https://nitro.jan.ai/): a bit lower effort to use out of the box
diff --git a/docs/docs/docs/02-integrations/ollama.md b/docs/docs/docs/02-integrations/ollama.md
@@ -0,0 +1,7 @@
+---
+title: Ollama
+---
+
+:::caution
+Requested, committed, but not started
+:::
diff --git a/docs/docs/docs/02-integrations/openai.md b/docs/docs/docs/02-integrations/openai.md
@@ -0,0 +1,8 @@
+---
+title: OpenAI
+---
+
+## Quicklinks
+
+- Jan Framework [Extension Code](https://github.com/janhq/jan/tree/main/extensions/inference-openai-extension)
+- OpenAI API [Reference Docs](https://platform.openai.com/docs/api-reference)
diff --git a/docs/docs/docs/02-integrations/openrouter.md b/docs/docs/docs/02-integrations/openrouter.md
@@ -0,0 +1,7 @@
+---
+title: OpenRouter
+---
+
+:::caution
+Requested, committed, but not started
+:::
diff --git a/docs/docs/docs/02-integrations/tensorrt.md b/docs/docs/docs/02-integrations/tensorrt.md
@@ -0,0 +1,8 @@
+---
+title: TensorRT-LLM
+---
+
+## Quicklinks
+
+- Jan Framework [Extension Code](https://github.com/janhq/jan/tree/main/extensions/inference-triton-trtllm-extension)
+- TensorRT [Source URL](https://github.com/NVIDIA/TensorRT-LLM)
diff --git a/docs/docs/docs/engineering/README.mdx → docs/docs/docs/03-engineering/README.mdx b/docs/docs/docs/engineering/README.mdx → docs/docs/docs/03-engineering/README.mdx
diff --git a/docs/docs/docs/engineering/assistants.md → docs/docs/docs/03-engineering/assistants.md b/docs/docs/docs/engineering/assistants.md → docs/docs/docs/03-engineering/assistants.md
diff --git a/docs/docs/docs/engineering/chats.md → docs/docs/docs/03-engineering/chats.md b/docs/docs/docs/engineering/chats.md → docs/docs/docs/03-engineering/chats.md
diff --git a/docs/docs/docs/engineering/engine.md → docs/docs/docs/03-engineering/engine.md b/docs/docs/docs/engineering/engine.md → docs/docs/docs/03-engineering/engine.md
diff --git a/docs/docs/docs/engineering/files.md → docs/docs/docs/03-engineering/files.md b/docs/docs/docs/engineering/files.md → docs/docs/docs/03-engineering/files.md
diff --git a/docs/docs/docs/engineering/fine-tuning.md → docs/docs/docs/03-engineering/fine-tuning.md b/docs/docs/docs/engineering/fine-tuning.md → docs/docs/docs/03-engineering/fine-tuning.md
diff --git a/docs/docs/docs/engineering/messages.md → docs/docs/docs/03-engineering/messages.md b/docs/docs/docs/engineering/messages.md → docs/docs/docs/03-engineering/messages.md
diff --git a/docs/docs/docs/engineering/models.md → docs/docs/docs/03-engineering/models.md b/docs/docs/docs/engineering/models.md → docs/docs/docs/03-engineering/models.md
diff --git a/docs/docs/docs/engineering/prompts.md → docs/docs/docs/03-engineering/prompts.md b/docs/docs/docs/engineering/prompts.md → docs/docs/docs/03-engineering/prompts.md
diff --git a/docs/docs/docs/engineering/threads.md → docs/docs/docs/03-engineering/threads.md b/docs/docs/docs/engineering/threads.md → docs/docs/docs/03-engineering/threads.md
diff --git a/docs/docs/docs/product/README.mdx → docs/docs/docs/03-product/README.mdx b/docs/docs/docs/product/README.mdx → docs/docs/docs/03-product/README.mdx
diff --git a/docs/docs/docs/product/chat.md → docs/docs/docs/03-product/chat.md b/docs/docs/docs/product/chat.md → docs/docs/docs/03-product/chat.md
diff --git a/docs/docs/docs/product/hub.md → docs/docs/docs/03-product/hub.md b/docs/docs/docs/product/hub.md → docs/docs/docs/03-product/hub.md
diff --git a/docs/docs/docs/product/jan.md → docs/docs/docs/03-product/jan.md b/docs/docs/docs/product/jan.md → docs/docs/docs/03-product/jan.md
diff --git a/docs/docs/docs/product/settings.md → docs/docs/docs/03-product/settings.md b/docs/docs/docs/product/settings.md → docs/docs/docs/03-product/settings.md
diff --git a/docs/docs/docs/product/system-monitor.md → docs/docs/docs/03-product/system-monitor.md b/docs/docs/docs/product/system-monitor.md → docs/docs/docs/03-product/system-monitor.md
diff --git a/docs/docs/docs/integrations/README.md b/docs/docs/docs/integrations/README.md
diff --git a/docs/docs/docs/integrations/langchain.md b/docs/docs/docs/integrations/langchain.md
diff --git a/docs/docs/docs/integrations/llamacpp.md b/docs/docs/docs/integrations/llamacpp.md
diff --git a/docs/docs/docs/integrations/ollama.md b/docs/docs/docs/integrations/ollama.md
diff --git a/docs/docs/docs/integrations/openai.md b/docs/docs/docs/integrations/openai.md
diff --git a/docs/docs/docs/integrations/openrouter.md b/docs/docs/docs/integrations/openrouter.md