Skip to content

Commit

Permalink
Merge pull request #994 from khoj-ai/features/update-desktop-app
Browse files Browse the repository at this point in the history
Simplify the desktop app

- Make the desktop app mainly a file-syncing client for users who have lots of documents that they need to share with Khoj. This is because the web app provides a fairly robust chat client which can be used by anyone on their computer.
- The chat client in the desktop app had significantly drifted from our current brand / them, and didn't provide enough value add to update. Later, we will make it easier to install the existing web app as a desktop PWA.
  • Loading branch information
sabaimran authored Dec 8, 2024
2 parents e3789ae + 05b3911 commit 6ed051d
Show file tree
Hide file tree
Showing 34 changed files with 400 additions and 2,763 deletions.
Binary file added documentation/assets/img/chrome_pwa_alt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed documentation/assets/img/khoj_chat_on_desktop.png
Binary file not shown.
Binary file removed documentation/assets/img/khoj_search_on_desktop.png
Binary file not shown.
Binary file removed documentation/assets/img/mic_chat_icon.png
Binary file not shown.
Binary file added documentation/assets/img/pwa_install_desktop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 21 additions & 17 deletions documentation/docs/clients/desktop.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,12 @@ sidebar_position: 1

# Desktop

> Query your Second Brain from your machine
> Upload your knowledge base to Khoj and chat with your whole corpus
Use the Desktop app to chat and search with Khoj.
You can also share your files, folders with Khoj using the app.
Khoj will keep these files in sync to provide contextual responses when you search or chat.
## Companion App

## Features
- **Chat**
- **Faster answers**: Find answers quickly, from your private notes or the public internet
- **Assisted creativity**: Smoothly weave across retrieving answers and generating content
- **Iterative discovery**: Iteratively explore and re-discover your notes
- **Quick access**: Use [Khoj Mini](/features/khoj_mini) on the desktop to quickly pull up a mini chat module for quicker answers
- **Search**
- **Natural**: Advanced natural language understanding using Transformer based ML Models
- **Incremental**: Incremental search for a fast, search-as-you-type experience
Share your files, folders with Khoj using the app.
Khoj will keep these files in sync to provide contextual responses when you search or chat.

## Setup
:::info[Self Hosting]
Expand All @@ -34,7 +25,20 @@ If you are self-hosting the Khoj server, update the *Settings* page on the Khoj
4. [Optional] Add any files, folders you'd like Khoj to be aware of on the *Settings* page and Click *Save*.
These files and folders will be automatically kept in sync for you

## Interface
| Chat | Search |
|:----:|:------:|
| ![](/img/khoj_chat_on_desktop.png) | ![](/img/khoj_search_on_desktop.png) |
# Main App

You can also install the Khoj application on your desktop as a progressive web app.

1. Open the [Khoj Web App](https://app.khoj.dev) in Chrome.
2. Click on the install button in the address bar to install the app. You must be logged into your Chrome browser for this to work.

![progressive web app install icon](/img/pwa_install_desktop.png)

Alternatively, you can also install using this route:

1. Open the three-dot menu in the top right corner of the browser.
2. Go to 'Cast, Save, and Share' option.
3. Click on the "Open in Khoj" option.


![progressive web app install route](/img/chrome_pwa_alt.png)
24 changes: 0 additions & 24 deletions src/interface/desktop/assets/icons/chat.svg

This file was deleted.

5 changes: 0 additions & 5 deletions src/interface/desktop/assets/icons/circular-add.svg

This file was deleted.

1 change: 1 addition & 0 deletions src/interface/desktop/assets/icons/clock.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion src/interface/desktop/assets/icons/confirm-icon.svg

This file was deleted.

10 changes: 1 addition & 9 deletions src/interface/desktop/assets/icons/file-not-synced.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 1 addition & 9 deletions src/interface/desktop/assets/icons/file-synced.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 0 additions & 28 deletions src/interface/desktop/assets/icons/folder.svg

This file was deleted.

4 changes: 0 additions & 4 deletions src/interface/desktop/assets/icons/key.svg

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file added src/interface/desktop/assets/icons/khoj_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 0 additions & 4 deletions src/interface/desktop/assets/icons/link.svg

This file was deleted.

1 change: 0 additions & 1 deletion src/interface/desktop/assets/icons/microphone-solid.svg

This file was deleted.

1 change: 1 addition & 0 deletions src/interface/desktop/assets/icons/open-link.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion src/interface/desktop/assets/icons/plaintext.svg

This file was deleted.

Loading

0 comments on commit 6ed051d

Please sign in to comment.