Skip to content

Commit

Permalink
Simplify links in Khoj docs to use page_name.md with no prefixes
Browse files Browse the repository at this point in the history
This allows jumping to page via VSCode IDE and on docs website
  • Loading branch information
debanjum committed Nov 19, 2023
1 parent fc65d8a commit d0e8438
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 12 deletions.
15 changes: 7 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,11 @@
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](./chat.md) with it about anything. When relevant, it'll use any notes or documents you shared with it to respond
- Use natural language to quickly [find](./search.md) relevant notes and documents
- Access it from your [Emacs](./emacs.md), [Obsidian](./obsidian.md), [Web browser](./web.md) or the [Khoj Desktop app](https://khoj.dev/downloads)
- It understands pdf, plaintext, markdown, org-mode files, [notion pages](./notion_integration.md) and [github repositories](./github_integration.md)
- You can self-host and run Khoj on your consumer hardware or private cloud
- It supports multiple users. If you want, you can self-host, a shared assistance server for your family, friends, or team
- You can [chat](chat.md) with it about anything. When relevant, it'll use any notes or documents you shared with it to respond
- Quickly [find](search.md) relevant notes and documents using natural language
- It understands pdf, plaintext, markdown, org-mode files, [notion pages](notion_integration.md) and [github repositories](github_integration.md)
- Access it from your [Emacs](emacs.md), [Obsidian](obsidian.md), [Web browser](web.md) or the [Khoj Desktop app](desktop.md)
- You can self-host Khoj on your consumer hardware or share it with your family, friends or team from your private cloud

## Quickstart
- [Try Khoj Cloud](https://app.khoj.dev) to get started quickly
Expand All @@ -43,11 +42,11 @@ Welcome to the Khoj Docs! This is the best place to get setup and explore Khoj's
<span>&nbsp;&nbsp;</span>
<img src="https://docs.khoj.dev/assets/khoj_chat_on_web.png" width="400px">

#### [Search](./search.md)
#### [Search](search.md)
- **Natural**: Use natural language queries to quickly find relevant notes and documents.
- **Incremental**: Incremental search for a fast, search-as-you-type experience

#### [Chat](./chat.md)
#### [Chat](chat.md)
- **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
Expand Down
4 changes: 2 additions & 2 deletions docs/emacs.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,13 @@ M-x package-install khoj
<!-- tabs:end -->
## Use
### Search
See [Khoj Search](/search) for details
See [Khoj Search](search.md) for details
1. Hit `C-c s s` (or `M-x khoj RET s`) to open khoj search
2. Enter your query in natural language<br/>
E.g *"What is the meaning of life?"*, *"My life goals for 2023"*

### Chat
See [Khoj Chat](/chat) for details
See [Khoj Chat](chat.md) for details
1. Hit `C-c s c` (or `M-x khoj RET c`) to open khoj chat
2. Ask questions in a natural, conversational style<br/>
E.g *"When did I file my taxes last year?"*
Expand Down
4 changes: 2 additions & 2 deletions docs/features.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## Features

#### [Search](./search.md)
#### [Search](search.md)
- **Local**: Your personal data stays local. All search and indexing is done on your machine.
- **Incremental**: Incremental search for a fast, search-as-you-type experience

#### [Chat](./chat.md)
#### [Chat](chat.md)
- **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
Expand Down

0 comments on commit d0e8438

Please sign in to comment.