From efc7b08cd9193fc69da0a96d288d4fcdee941682 Mon Sep 17 00:00:00 2001 From: Debanjum Singh Solanky Date: Mon, 8 Jan 2024 01:52:12 +0530 Subject: [PATCH] Use Khoj Client, Data sources diagrams in feature docs --- documentation/assets/img/khoj_clients.svg | 74 +++++++++++++++++++ documentation/assets/img/khoj_datasources.svg | 62 ++++++++++++++++ documentation/docs/features/all_features.md | 21 +++--- documentation/docs/get-started/overview.md | 4 +- 4 files changed, 148 insertions(+), 13 deletions(-) create mode 100644 documentation/assets/img/khoj_clients.svg create mode 100644 documentation/assets/img/khoj_datasources.svg diff --git a/documentation/assets/img/khoj_clients.svg b/documentation/assets/img/khoj_clients.svg new file mode 100644 index 00000000..35f005e7 --- /dev/null +++ b/documentation/assets/img/khoj_clients.svg @@ -0,0 +1,74 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/documentation/assets/img/khoj_datasources.svg b/documentation/assets/img/khoj_datasources.svg new file mode 100644 index 00000000..5b72c689 --- /dev/null +++ b/documentation/assets/img/khoj_datasources.svg @@ -0,0 +1,62 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/documentation/docs/features/all_features.md b/documentation/docs/features/all_features.md index b8930705..c482805b 100644 --- a/documentation/docs/features/all_features.md +++ b/documentation/docs/features/all_features.md @@ -7,29 +7,28 @@ sidebar_position: 1 Khoj supports a variety of features, including search and chat with a wide range of data sources and interfaces. #### [Search](/features/search) - - **Local**: Your personal data stays local. All search and indexing is done on your machine. + - **Local**: Your personal data stays local. All search and indexing is done on your machine when you [self-host](/get-started/setup) - **Incremental**: Incremental search for a fast, search-as-you-type experience #### [Chat](/features/chat) - **Faster answers**: Find answers faster, smoother than search. No need to manually scan through your notes to find answers. - **Iterative discovery**: Iteratively explore and (re-)discover your notes - **Assisted creativity**: Smoothly weave across answers retrieval and content generation + - **Works online or offline**: Chat using online or offline AI chat models #### General + - **Cloud or Self-Host**: Use [cloud](https://app.khoj.dev/login) to use Khoj anytime from anywhere or [self-host](/get-started/setup) for privacy - **Natural**: Advanced natural language understanding using Transformer based ML Models - **Pluggable**: Modular architecture makes it easy to plug in new data sources, frontends and ML models - - **Multiple Sources**: Index your Org-mode and Markdown notes, PDF files, Github repositories, and Photos - - **Multiple Interfaces**: Interact from your [Web Browser](/clients/web), [Emacs](/clients/emacs) or [Obsidian](/clients/obsidian) + - **Multiple Sources**: Index your Org-mode, Markdown, PDF, plaintext files, Github repos and Notion pages + - **Multiple Interfaces**: Interact from your Web Browser, Emacs, Obsidian, Desktop app or even Whatsapp ### Supported Interfaces +Khoj is available as a [Desktop app](/clients/desktop), [Emacs package](/clients/emacs), [Obsidian plugin](/clients/obsidian), [Web app](/clients/web) and a [Whatsapp AI](https://khoj.dev/whatsapp). -[![Khoj on Emacs](https://img.shields.io/badge/Emacs-%237F5AB6.svg?&style=for-the-badge&logo=gnu-emacs&logoColor=white)](/docs/clients/emacs) -  -[![Khoj on Obsidian](https://img.shields.io/badge/Obsidian-%23483699.svg?style=for-the-badge&logo=obsidian&logoColor=white)](/docs/clients/obsidian) +![](/img/khoj_clients.svg ':size=400px') ### Supported Data Sources -- markdown -- org-mode -- pdf -- [github](/online-data-sources/github_integration) -- [notion](/online-data-sources/notion_integration) +Khoj can understand your org-mode, markdown, PDF, plaintext files, [Github projects](/online-data-sources/github_integration) and [Notion pages](/online-data-sources/notion_integration). + +![](/img/khoj_datasources.svg ':size=200px') diff --git a/documentation/docs/get-started/overview.md b/documentation/docs/get-started/overview.md index f9080eec..4b571226 100644 --- a/documentation/docs/get-started/overview.md +++ b/documentation/docs/get-started/overview.md @@ -26,11 +26,11 @@ slug: / Welcome to the Khoj Docs! This is the best place to get setup and explore Khoj's features. - Khoj is an open source, personal AI -- You can [chat](/features/chat) with it about anything. When relevant, it'll use any notes or documents you shared with it to respond +- You can [chat](/features/chat) with it about anything. It'll use files you shared with it to respond, when relevant - Quickly [find](/features/search) relevant notes and documents using natural language - It understands pdf, plaintext, markdown, org-mode files, [notion pages](/online-data-sources/notion_integration) and [github repositories](/online-data-sources/github_integration) - Access it from your [Emacs](/clients/emacs), [Obsidian](/clients/obsidian), [Web browser](/clients/web) or the [Khoj Desktop app](/clients/desktop) -- You can self-host Khoj on your consumer hardware or share it with your family, friends or team from your private cloud +- Use [cloud](https://app.khoj.dev/login) to access your Khoj anytime from anywhere, [self-host](/get-started/setup) on consumer hardware for privacy ## Quickstart - [Try Khoj Cloud](https://app.khoj.dev) to get started quickly