Fix links to demos and screenshots in docs

This commit is contained in:
Debanjum Singh Solanky 2023-07-21 20:01:19 -07:00
parent 89ad362758
commit 4089e38283
5 changed files with 20 additions and 20 deletions

View file

@ -31,7 +31,7 @@ Khoj gives you lightning fast, offline search on your personal machine and gives
- **Multiple Interfaces**: Interact from your [Web Browser](https://docs.khoj.dev/#/web), [Emacs](https://docs.khoj.dev/#/emacs) or [Obsidian](https://docs.khoj.dev/#/obsidian) - **Multiple Interfaces**: Interact from your [Web Browser](https://docs.khoj.dev/#/web), [Emacs](https://docs.khoj.dev/#/emacs) or [Obsidian](https://docs.khoj.dev/#/obsidian)
## Install ## Install
[Click here](./setup.md) for full setup instructions. [Click here](/setup) for full setup instructions.
## Supported data sources ## Supported data sources
- markdown* - markdown*

View file

@ -20,18 +20,17 @@
- **Assisted creativity**: Smoothly weave across answer retrieval and content generation - **Assisted creativity**: Smoothly weave across answer retrieval and content generation
## Interface ## Interface
### Search UI #### Search
![khoj search on emacs](./assets/khoj_search_on_emacs.png ':size=400px')
![khoj_emacs](./assets/khoj_on_emacs.png) #### Chat
![khoj chat on emacs](./assets/khoj_chat_on_emacs.png ':size=400px')
### Chat UI
![khoj_chat_emacs](./assets/khoj_chat_on_emacs_0.5.0.png)
## Setup ## Setup
- /Make sure [[https://realpython.com/installing-python/][python]] and [[https://pip.pypa.io/en/stable/installation/][pip]] are installed on your machine/ - *Make sure [python](https://realpython.com/installing-python/) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine*
- /khoj.el attempts to automatically install, start and configure the khoj server./ - *khoj.el attempts to automatically install, start and configure the khoj server.*
If this fails, follow [[https://github.com/khoj-ai/khoj/tree/master/#Setup][these instructions]] to manually setup the khoj server. If this fails, follow [these instructions](/setup) to manually setup the khoj server.
### Direct Install ### Direct Install
```elisp ```elisp
@ -70,7 +69,7 @@ Indexes your org-agenda files, by default.
khoj-openai-api-key "YOUR_OPENAI_API_KEY")) ; required to enable chat khoj-openai-api-key "YOUR_OPENAI_API_KEY")) ; required to enable chat
``` ```
### With [https://github.com/raxod502/straight.el](Straight.el) ### With [Straight.el](https://github.com/raxod502/straight.el)
Add below snippet to your Emacs config file. Add below snippet to your Emacs config file.
Indexes the specified org files, directories. Sets up OpenAI API key for Khoj Chat Indexes the specified org files, directories. Sets up OpenAI API key for Khoj Chat
@ -108,7 +107,7 @@ This feature finds entries similar to the one you are currently on.
2. Hit `C-c s f` (or `M-x khoj RET f`) to find similar entries 2. Hit `C-c s f` (or `M-x khoj RET f`) to find similar entries
### Advanced Usage ### Advanced Usage
- Add [[https://github.com/khoj-ai/khoj/#query-filters][query filters]] during search to narrow down results further - Add [query filters](https://github.com/khoj-ai/khoj/#query-filters) during search to narrow down results further
e.g `What is the meaning of life? -"god" +"none" dt>"last week"` e.g `What is the meaning of life? -"god" +"none" dt>"last week"`

View file

@ -49,7 +49,7 @@ Notes:
- *Using Khoj Chat will result in query relevant notes being shared with OpenAI for ChatGPT to respond.* - *Using Khoj Chat will result in query relevant notes being shared with OpenAI for ChatGPT to respond.*
- *To use Khoj Chat, ensure you've set your [OpenAI API key](https://platform.openai.com/account/api-keys) in the Khoj plugin settings.* - *To use Khoj Chat, ensure you've set your [OpenAI API key](https://platform.openai.com/account/api-keys) in the Khoj plugin settings.*
See [Khoj Chat](https://github.com/khoj-ai/khoj/tree/master/#Khoj-Chat) for more details See [Khoj Chat](/chat) for more details
### Search ### Search
Click the *Khoj search* icon 🔎 on the [Ribbon](https://help.obsidian.md/User+interface/Workspace/Ribbon) or run *Khoj: Search* from the [Command Palette](https://help.obsidian.md/Plugins/Command+palette) Click the *Khoj search* icon 🔎 on the [Ribbon](https://help.obsidian.md/User+interface/Workspace/Ribbon) or run *Khoj: Search* from the [Command Palette](https://help.obsidian.md/Plugins/Command+palette)

View file

@ -2,9 +2,9 @@
These are the general setup instructions for Khoj. These are the general setup instructions for Khoj.
- Make sure [python](https://realpython.com/installing-python/) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine - Make sure [python](https://realpython.com/installing-python/) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine
- Check the [Khoj.el Readme](https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Setup) to setup Khoj with Emacs<br /> - Check the [Khoj Emacs docs](/emacs?id=setup) to setup Khoj with Emacs<br />
Its simpler as it can skip the server *install*, *run* and *configure* step below. Its simpler as it can skip the server *install*, *run* and *configure* step below.
- Check the [Khoj Obsidian Readme](https://github.com/khoj-ai/khoj/tree/master/src/interface/obsidian#Setup) to setup Khoj with Obsidian<br /> - Check the [Khoj Obsidian docs](/obsidian?id=_2-setup-plugin) to setup Khoj with Obsidian<br />
Its simpler as it can skip the *configure* step below. Its simpler as it can skip the *configure* step below.
### 1. Install ### 1. Install
@ -37,17 +37,17 @@ Note: To start Khoj automatically in the background use [Task scheduler](https:/
2. Add your OpenAI API key to Chat Feature settings if you want to use Chat 2. Add your OpenAI API key to Chat Feature settings if you want to use Chat
3. Click `Configure` and wait. The app will download ML models and index the content for search and (optionally) chat 3. Click `Configure` and wait. The app will download ML models and index the content for search and (optionally) chat
[configure demo](./assets/khoj_configure_on_web.mp4 ':include :type=mp4') ![configure demo](https://user-images.githubusercontent.com/6413477/255307879-61247d3f-c69a-46ef-b058-9bc533cb5c72.mp4 ':include :type=mp4')
### 4. Install Interface Plugins (Optional) ### 4. Install Interface Plugins (Optional)
Khoj exposes a web interface to search, chat and configure by default.<br /> Khoj exposes a web interface to search, chat and configure by default.<br />
The optional steps below allow using Khoj from within an existing application like Obsidian or Emacs. The optional steps below allow using Khoj from within an existing application like Obsidian or Emacs.
- **Khoj Obsidian**:<br /> - **Khoj Obsidian**:<br />
[Install](https://github.com/khoj-ai/khoj/tree/master/src/interface/obsidian#2-Setup-Plugin) the Khoj Obsidian plugin [Install](/obsidian?id=_2-setup-plugin) the Khoj Obsidian plugin
- **Khoj Emacs**:<br /> - **Khoj Emacs**:<br />
[Install](https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#2-Install-Khojel) khoj.el [Install](/emacs?id=setup) khoj.el
## Upgrade ## Upgrade
@ -64,11 +64,11 @@ pip install --upgrade --pre khoj-assistant
### Upgrade Khoj on Emacs ### Upgrade Khoj on Emacs
- Use your Emacs Package Manager to Upgrade - Use your Emacs Package Manager to Upgrade
- See [khoj.el readme](https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Upgrade) for details - See [khoj.el package setup](/emacs?id=setup) for details
### Upgrade Khoj on Obsidian ### Upgrade Khoj on Obsidian
- Upgrade via the Community plugins tab on the settings pane in the Obsidian app - Upgrade via the Community plugins tab on the settings pane in the Obsidian app
- See the [khoj plugin readme](https://github.com/khoj-ai/khoj/tree/master/src/interface/obsidian#2-Setup-Plugin) for details - See the [khoj plugin setup](/obsidian.md?id=_2-setup-plugin) for details
## Uninstall ## Uninstall
1. (Optional) Hit `Ctrl-C` in the terminal running the khoj server to stop it 1. (Optional) Hit `Ctrl-C` in the terminal running the khoj server to stop it

View file

@ -16,4 +16,5 @@
The Khoj web interface is the default interface. It comes packaged with the khoj server. The Khoj web interface is the default interface. It comes packaged with the khoj server.
## Interface ## Interface
![](./assets/khoj_chat_web_interface.png?) ![](./assets/khoj_search_on_web.png ':size=400px')
![](./assets/khoj_chat_on_web.png ':size=400px')