klbr/khoj
1
0
Fork 0
mirror of https://github.com/khoaliber/khoj.git synced 2026-03-07 13:23:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix, update Obsidian Readme. Add Find Similar Notes to Implementation section

Browse Source
This commit is contained in:
Debanjum Singh Solanky
2023-01-18 00:22:26 -03:00
parent b7fc344be1
commit 5c07dcd219
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/interface/obsidian/README.md
View File

@@ -96,13 +96,13 @@ To see other notes similar to the current one, run *Khoj: Find Similar Notes* fr
3. Click the *Update* button next to Khoj, if available 3. Click the *Update* button next to Khoj, if available
## Troubleshooting ## Troubleshooting
1. Open the Khoj plugin settings pane, in case you need to configure Khoj - Open the Khoj plugin settings pane, to configure Khoj
2. Toggle Enable/Disable Khoj, in case settings changes have not applied - Toggle Enable/Disable Khoj, if setting changes have not applied
3. Click *Update* button to force index to refresh if results are failing or stale - Click *Update* button to force index to refresh, if results are failing or stale
## Current Limitations ## Current Limitations
- The plugin loads index of only one vault at a time.<br/> - The plugin loads the index of only one vault at a time.<br/>
So notes across multiple vaults **cannot** be search at the same time So notes across multiple vaults **cannot** be searched at the same time
## Visualize Codebase ## Visualize Codebase
<img src="https://github.com/debanjum/khoj/blob/master/src/interface/obsidian/docs/khoj_obsidian_codebase_visualization_0.2.1.png" width="700" /> <img src="https://github.com/debanjum/khoj/blob/master/src/interface/obsidian/docs/khoj_obsidian_codebase_visualization_0.2.1.png" width="700" />
@@ -115,4 +115,5 @@ The plugin implements the following functionality to search your notes with Khoj
- Set Obsidian Vault to Index with Khoj. Defaults to all markdown files in current Vault - Set Obsidian Vault to Index with Khoj. Defaults to all markdown files in current Vault
- Set URL of Khoj backend - Set URL of Khoj backend
- Set Number of Search Results to show in Search Modal - Set Number of Search Results to show in Search Modal
- [X] Allow user to trigger reranking of result to improve search quality - [X] Allow reranking of result to improve search quality
- [X] Allow Finding notes similar to current note being viewed