From 4089e38283067f6b47c088aa3d04bd7865e42ed9 Mon Sep 17 00:00:00 2001 From: Debanjum Singh Solanky Date: Fri, 21 Jul 2023 20:01:19 -0700 Subject: [PATCH] Fix links to demos and screenshots in docs --- docs/README.md | 2 +- docs/emacs.md | 19 +++++++++---------- docs/obsidian.md | 2 +- docs/setup.md | 14 +++++++------- docs/web.md | 3 ++- 5 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/README.md b/docs/README.md index 98b614ba..75cfcb81 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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) ## Install -[Click here](./setup.md) for full setup instructions. +[Click here](/setup) for full setup instructions. ## Supported data sources - markdown* diff --git a/docs/emacs.md b/docs/emacs.md index 0ae0cea2..cc8c4634 100644 --- a/docs/emacs.md +++ b/docs/emacs.md @@ -20,18 +20,17 @@ - **Assisted creativity**: Smoothly weave across answer retrieval and content generation ## Interface -### Search UI +#### Search +![khoj search on emacs](./assets/khoj_search_on_emacs.png ':size=400px') -![khoj_emacs](./assets/khoj_on_emacs.png) - -### Chat UI -![khoj_chat_emacs](./assets/khoj_chat_on_emacs_0.5.0.png) +#### Chat +![khoj chat on emacs](./assets/khoj_chat_on_emacs.png ':size=400px') ## 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./ - If this fails, follow [[https://github.com/khoj-ai/khoj/tree/master/#Setup][these instructions]] to manually setup the khoj server. +- *khoj.el attempts to automatically install, start and configure the khoj server.* + If this fails, follow [these instructions](/setup) to manually setup the khoj server. ### Direct Install ```elisp @@ -70,7 +69,7 @@ Indexes your org-agenda files, by default. 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. 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 ### 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"` diff --git a/docs/obsidian.md b/docs/obsidian.md index 2d2ee761..dfcb3e02 100644 --- a/docs/obsidian.md +++ b/docs/obsidian.md @@ -49,7 +49,7 @@ Notes: - *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.* -See [Khoj Chat](https://github.com/khoj-ai/khoj/tree/master/#Khoj-Chat) for more details +See [Khoj Chat](/chat) for more details ### 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) diff --git a/docs/setup.md b/docs/setup.md index 2755edd6..7500d7ca 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -2,9 +2,9 @@ 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 -- Check the [Khoj.el Readme](https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#Setup) to setup Khoj with Emacs
+- Check the [Khoj Emacs docs](/emacs?id=setup) to setup Khoj with Emacs
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
+- Check the [Khoj Obsidian docs](/obsidian?id=_2-setup-plugin) to setup Khoj with Obsidian
Its simpler as it can skip the *configure* step below. ### 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 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) Khoj exposes a web interface to search, chat and configure by default.
The optional steps below allow using Khoj from within an existing application like Obsidian or Emacs. - **Khoj Obsidian**:
-[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**:
-[Install](https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#2-Install-Khojel) khoj.el +[Install](/emacs?id=setup) khoj.el ## Upgrade @@ -64,11 +64,11 @@ pip install --upgrade --pre khoj-assistant ### Upgrade Khoj on Emacs - 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 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 1. (Optional) Hit `Ctrl-C` in the terminal running the khoj server to stop it diff --git a/docs/web.md b/docs/web.md index 190fb956..6601fb24 100644 --- a/docs/web.md +++ b/docs/web.md @@ -16,4 +16,5 @@ The Khoj web interface is the default interface. It comes packaged with the khoj server. ## Interface -![](./assets/khoj_chat_web_interface.png?) +![](./assets/khoj_search_on_web.png ':size=400px') +![](./assets/khoj_chat_on_web.png ':size=400px')