Merge pull request janhq#1092 from janhq/fix1089

docs: dev docs
hiro-v · Dec 20, 2023 · 58bfbab · 58bfbab
2 parents a9c3416 + 7a08526
commit 58bfbab
Show file tree

Hide file tree

Showing 77 changed files with 637 additions and 367 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -2,6 +2,33 @@
 
 This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
 
+## Information Architecture
+
+We try to **keep routes consistent** to maintain SEO.
+
+- `/guides`: Guides on how to use the Jan application, with GIFs. For end users who are directly using Jan. Always assume users are not technical.
+
+- `/developer`: Developer docs on how to extend Jan. These pages are about what people can build with our software. We must hide the complexity of HOW the app is built, but explain just enough of the high level architecture so devs know enough to build on top of it.
+
+- `/api-reference`: Reference documentation, written in Swagger/OpenAPI format.
+
+- `/docs`: Engineering specs and product specs, i.e. HOW the app is built. Mostly for internal reference and for our core contributors who are building the SDK itself.
+
+### Sidebar Autogeneration
+
+The order of each page is either explicitly defined in `sidebar.js` or follows the [Docusaurus autogenerated](https://docusaurus.io/docs/next/sidebar/autogenerated) naming format, `##-path-name.md`.
+
+Important slugs are hardcoded at the document level (and shouldn't be rerouted):
+
+```md
+---
+title: Overview
+slug: /docs
+---
+```
+
+## Contributing
+
 ### Installation
 
 ```
@@ -48,5 +75,6 @@ When a PR is created, the preview URL will be automatically commented on the PR.
 The documentation will then be published to [https://jan.ai/](https://jan.ai/) when the PR is merged to `main`.
 
 ### Additional Plugins
+
 - @docusaurus/theme-live-codeblock
-- [Redocusaurus](https://redocusaurus.vercel.app/): manually upload swagger files at `/openapi/OpenAPISpec.json`
+- [Redocusaurus](https://redocusaurus.vercel.app/): manually upload swagger files at `/openapi/OpenAPISpec.json`
diff --git a/docs/docs/specs/architecture.md → .../developer/01-overview/01-architecture.md b/docs/docs/specs/architecture.md → .../developer/01-overview/01-architecture.md
@@ -1,8 +1,18 @@
 ---
 title: Architecture
-slug: /specs
+slug: /developer/architecture
 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,
+  ]
 ---
 
 :::warning
@@ -14,8 +24,9 @@ This page is still under construction, and should be read as a scratchpad
 ## Overview
 
 - Jan has a modular architecture and is largely built on top of its own modules.
-- Jan uses a local [file-based approach](/specs/file-based) for data persistence.
-- Jan currently supports an Electron-based [Desktop UI](https://github.com/janhq/jan) and a C++ inference engine called [Nitro](https://nitro.jan.ai/docs/).
+- Jan uses a local [file-based approach](/developer/file-based) for data persistence.
+- Jan provides an Electron-based [Desktop UI](https://github.com/janhq/jan).
+- Jan provides an embeddable inference engine, written in C++, called [Nitro](https://nitro.jan.ai/docs/).
 
 ## Extensions
 

diff --git a/docs/docs/specs/file-based.md → ...cs/developer/01-overview/02-file-based.md b/docs/docs/specs/file-based.md → ...cs/developer/01-overview/02-file-based.md
@@ -1,7 +1,18 @@
 ---
 title: File-based Approach
+slug: /developer/file-based
 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,
+  ]
 ---
 
 :::warning

diff --git a/docs/docs/specs/user-interface.md → ...eveloper/01-overview/03-user-interface.md b/docs/docs/specs/user-interface.md → ...eveloper/01-overview/03-user-interface.md
@@ -1,7 +1,18 @@
 ---
 title: User Interface
+slug: /developer/ui
 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,
+  ]
 ---
 
 :::warning

diff --git a/docs/docs/developer/01-overview/README.md b/docs/docs/developer/01-overview/README.md
@@ -0,0 +1,36 @@
+---
+title: Overview
+slug: /developer
+description: Jan Docs | 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,
+  ]
+---
+
+Jan SDK is an **extensible framework** that lets you build and run AI applications everywhere, with an emphasis on local first.
+
+It is available across Mac, Windows, Linux Desktops. It is also available as a headless server that can be deployed into any on-prem or cloud environments.
+
+This framework is packaged and regularly published as an SDK through [npm](https://www.npmjs.com/org/janhq) and [pip](https://pypi.org/).
+
+The SDK provides built-in support for the following:
+
+- Native OS integrations with Electron and Chromium
+- Native server integrations with Nodejs
+- Native mobile integrations with Capacitor (coming soon)
+
+:::tip
+The [Jan Desktop client](https://github.com/janhq/jan/releases) is built with Jan SDK. This means you can customize any part of the application from the branding to the features, and truly make it your own.
+:::
+
+## Jan in Action
+
+[Gif: show desktop & server side by side]
diff --git a/docs/docs/developer/02-build-assistant/01-your-first-assistant.md b/docs/docs/developer/02-build-assistant/01-your-first-assistant.md
@@ -0,0 +1,9 @@
+---
+title: Your First Assistant
+---
+
+:::caution
+This is currently under development.
+:::
+
+A quickstart on how to build an assistant
diff --git a/docs/docs/developer/02-build-assistant/02-assistant-anatomy.md b/docs/docs/developer/02-build-assistant/02-assistant-anatomy.md
@@ -0,0 +1,9 @@
+---
+title: Anatomy of an Assistant
+---
+
+:::caution
+This is currently under development.
+:::
+
+An overview of assistant.json
diff --git a/docs/docs/developer/02-build-assistant/03-package-your-assistant.md b/docs/docs/developer/02-build-assistant/03-package-your-assistant.md
@@ -0,0 +1,9 @@
+---
+title: Package your Assistant
+---
+
+:::caution
+This is currently under development.
+:::
+
+Packaging, exporting, sharing, publishing an assistant to Hub
diff --git a/docs/docs/developer/02-build-assistant/README.md b/docs/docs/developer/02-build-assistant/README.md
@@ -0,0 +1,12 @@
+---
+title: Build an Assistant
+---
+
+:::caution
+This is currently under development.
+:::
+
+In this tutorial you will learn:
+
+-
+-
diff --git a/docs/docs/developer/03-build-engine/01-your-first-engine.md b/docs/docs/developer/03-build-engine/01-your-first-engine.md
@@ -0,0 +1,9 @@
+---
+title: Your First Assistant
+---
+
+:::caution
+This is currently under development.
+:::
+
+A quickstart on how to integrate tensorrt llm
diff --git a/.../docs/03-extension-capabilities/README.md → ...oper/03-build-engine/02-engine-anatomy.md b/.../docs/03-extension-capabilities/README.md → ...oper/03-build-engine/02-engine-anatomy.md
@@ -1,9 +1,9 @@
 ---
-title: Extension Capabilities
+title: Anatomy of an Engine
 ---
 
-# Overview
-
 :::caution
 This is currently under development.
 :::
+
+An overview of engine.json
diff --git a/docs/docs/developer/03-build-engine/03-package-your-engine.md b/docs/docs/developer/03-build-engine/03-package-your-engine.md
@@ -0,0 +1,9 @@
+---
+title: Package your Extension
+---
+
+:::caution
+This is currently under development.
+:::
+
+Packaging, exporting, sharing, publishing an engine config to Hub
diff --git a/docs/docs/developer/03-build-engine/README.md b/docs/docs/developer/03-build-engine/README.md
@@ -0,0 +1,12 @@
+---
+title: Build an Inference Engine
+---
+
+:::caution
+This is currently under development.
+:::
+
+In this tutorial you will learn:
+
+-
+-
diff --git a/docs/docs/developer/04-build-extension/01-your-first-extension.md b/docs/docs/developer/04-build-extension/01-your-first-extension.md
@@ -0,0 +1,9 @@
+---
+title: Your First Extension
+---
+
+:::caution
+This is currently under development.
+:::
+
+A quickstart on tensorrt-llm impl
diff --git a/...cs/02-get-started/02-extension-anatomy.md → ...4-build-extension/02-extension-anatomy.md b/...cs/02-get-started/02-extension-anatomy.md → ...4-build-extension/02-extension-anatomy.md
@@ -6,4 +6,4 @@ title: Anatomy of an Extension
 This is currently under development.
 :::
 
-Anatomy and lifecycle
+An overview of engine.json
diff --git a/docs/docs/developer/04-build-extension/03-package-your-assistant.md b/docs/docs/developer/04-build-extension/03-package-your-assistant.md
@@ -0,0 +1,9 @@
+---
+title: Package your Extension
+---
+
+:::caution
+This is currently under development.
+:::
+
+Packaging, exporting, sharing, publishing an extension to Hub
diff --git a/...docs/02-get-started/01-build-extension.md → ...cs/developer/04-build-extension/README.md b/...docs/02-get-started/01-build-extension.md → ...cs/developer/04-build-extension/README.md
@@ -2,6 +2,8 @@
 title: Build an Extension
 ---
 
+# Overview
+
 :::caution
 This is currently under development.
 :::
diff --git a/docs/docs/docs/01-overview.md b/docs/docs/docs/01-overview.md
diff --git a/docs/docs/docs/02-get-started/03-use-local-server.md b/docs/docs/docs/02-get-started/03-use-local-server.md
diff --git a/docs/docs/docs/02-get-started/04-build-on-desktop.md b/docs/docs/docs/02-get-started/04-build-on-desktop.md
diff --git a/docs/docs/docs/02-get-started/05-build-on-mobile.md b/docs/docs/docs/02-get-started/05-build-on-mobile.md
diff --git a/docs/docs/docs/02-get-started/README.md b/docs/docs/docs/02-get-started/README.md
diff --git a/docs/docs/docs/03-extension-capabilities/01-Core.md b/docs/docs/docs/03-extension-capabilities/01-Core.md
diff --git a/docs/docs/docs/03-extension-capabilities/02-common-extensions.md b/docs/docs/docs/03-extension-capabilities/02-common-extensions.md
diff --git a/docs/docs/docs/04-extension-guides/README.md b/docs/docs/docs/04-extension-guides/README.md
diff --git a/docs/docs/docs/04-extension-guides/assistant.md b/docs/docs/docs/04-extension-guides/assistant.md
diff --git a/docs/docs/docs/04-extension-guides/inference.md b/docs/docs/docs/04-extension-guides/inference.md
diff --git a/docs/docs/docs/04-extension-guides/model.md b/docs/docs/docs/04-extension-guides/model.md
diff --git a/docs/docs/docs/04-extension-guides/monitoring.md b/docs/docs/docs/04-extension-guides/monitoring.md
diff --git a/docs/docs/docs/04-extension-guides/threads-messages.md b/docs/docs/docs/04-extension-guides/threads-messages.md