Align docs landing page with updated github readme

- Screenshots of khoj search, chat - Put quickstart on landing page - Put miscellaneous pages under separate section - Move credits to separate page under miscellaneous
2024-11-23 23:48:56 +01:00 · 2023-07-29 12:42:36 -07:00 · 2023-07-29 12:42:36 -07:00 · a3d1212e79
commit a3d1212e79
parent d7205aed36
4 changed files with 74 additions and 45 deletions
--- a/docs/README.md
+++ b/docs/README.md
@ -1,54 +1,53 @@
-<h1><img src="./assets/khoj-logo-sideways.svg" width="200" alt="Khoj Logo"></h1>
+<p align="center"><img src="./assets/khoj-logo-sideways.svg" width="200" alt="Khoj Logo"></p>
+
+<div align="center">

 [![test](https://github.com/khoj-ai/khoj/actions/workflows/test.yml/badge.svg)](https://github.com/khoj-ai/khoj/actions/workflows/test.yml)
 [![dockerize](https://github.com/khoj-ai/khoj/actions/workflows/dockerize.yml/badge.svg)](https://github.com/khoj-ai/khoj/pkgs/container/khoj)
 [![pypi](https://github.com/khoj-ai/khoj/actions/workflows/pypi.yml/badge.svg)](https://pypi.org/project/khoj-assistant/)

-# Khoj
-*An AI personal assistant for your digital brain*
+</div>

-Welcome to the Khoj Docs! This is the best place to get started with Khoj. Check out our [Github](https://github.com/khoj-ai/khoj) to explore the code or our [Website](https://khoj.dev) for an invite up to Khoj cloud.
+<div align="center">
+<b>An AI personal assistant for your digital brain</b>

-Khoj gives you lightning fast, offline search on your personal machine and gives you the power to talk to your notes.
+</div>

-**Supported Plugins**
+<div align="center">

-[![Khoj on Obsidian](https://img.shields.io/badge/Obsidian-%23483699.svg?style=for-the-badge&logo=obsidian&logoColor=white)](https://github.com/khoj-ai/khoj/tree/master/src/interface/obsidian#readme)
-[![Khoj on Emacs](https://img.shields.io/badge/Emacs-%237F5AB6.svg?&style=for-the-badge&logo=gnu-emacs&logoColor=white)](https://github.com/khoj-ai/khoj/tree/master/src/interface/emacs#readme)
+[📜 Explore Code](https://github.com/khoj-ai/khoj)
+<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+[🌍 Try Khoj Cloud](https://khoj.dev)
+<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+[💬 Get Involved](https://discord.gg/BDgyabRM6e)

-## Features
- **Search**
-  - **Local**: Your personal data stays local. All search and indexing is done on your machine. *Unlike chat which requires access to GPT.*
+</div>
+
+## Introduction
+Welcome to the Khoj Docs! This is the best place to [get started](./setup.md) with Khoj.
+
+- Khoj is a desktop application to [search](./search.md) and [chat](./chat.md) with your notes, documents and images
+- It is an offline-first, open source AI personal assistant accessible from your [Emacs](./emacs.md), [Obsidian](./obsidian.md) or [Web browser](./web.md)
+- It works with jpeg, markdown, [notion](./notion_integration.md) org-mode, pdf files and [github repositories](./github_integration.md)
+
+## Quickstart
+[Click here](/setup) for full setup instructions
+
+```shell
+pip install khoj-assistant && khoj
+```
+
+## Overview
+<img src="https://docs.khoj.dev/assets/khoj_search_on_web.png" width="400px">
+<span>&nbsp;&nbsp;</span>
+<img src="https://docs.khoj.dev/assets/khoj_chat_on_web.png" width="400px">
+
+#### [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](./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
- **General**
-  - **Natural**: Advanced natural language understanding using Transformer based ML Models
-  - **Pluggable**: Modular architecture makes it easy to plug in new data sources, frontends and ML models
-  - **Multiple Sources**: Index your Org-mode and Markdown notes, PDF files, Github repositories, and Photos
-  - **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) for full setup instructions.
-
-## Supported data sources
- markdown*
- org-mode*
- pdf*
- images*
- github
- notion
-
-\* These data sources are offline only.
-
-If you're using Github or Notion, you can get on a waitlist for [Khoj Cloud](https://khoj.dev).
-
-## Credits
-
- [Multi-QA MiniLM Model](https://huggingface.co/sentence-transformers/multi-qa-MiniLM-L6-cos-v1), [All MiniLM Model](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2) for Text Search. See [SBert Documentation](https://www.sbert.net/examples/applications/retrieve_rerank/README.html)
- [OpenAI CLIP Model](https://github.com/openai/CLIP) for Image Search. See [SBert Documentation](https://www.sbert.net/examples/applications/image-search/README.html)
- Charles Cave for [OrgNode Parser](http://members.optusnet.com.au/~charles57/GTD/orgnode.html)
- [Org.js](https://mooz.github.io/org-js/) to render Org-mode results on the Web interface
- [Markdown-it](https://github.com/markdown-it/markdown-it) to render Markdown results on the Web interface
+  - **Online or Offline**: Choose online or offline chat depending on your requirements
--- a/docs/_sidebar.md
+++ b/docs/_sidebar.md
@ -14,7 +14,9 @@
    - Data Sources
        - [Github](github_integration.md)
        - [Notion](notion_integration.md)
+- Miscellaneous
    - [Advanced](advanced.md)
    - [Performance](performance.md)
+    - [Credits](credits.md)
 - Contributing
    - [Development](development.md)
--- a/docs/credits.md
+++ b/docs/credits.md
@ -0,0 +1,7 @@
+## Credits
+
+- [Multi-QA MiniLM Model](https://huggingface.co/sentence-transformers/multi-qa-MiniLM-L6-cos-v1), [All MiniLM Model](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2) for Text Search. See [SBert Documentation](https://www.sbert.net/examples/applications/retrieve_rerank/README.html)
+- [OpenAI CLIP Model](https://github.com/openai/CLIP) for Image Search. See [SBert Documentation](https://www.sbert.net/examples/applications/image-search/README.html)
+- Charles Cave for [OrgNode Parser](http://members.optusnet.com.au/~charles57/GTD/orgnode.html)
+- [Org.js](https://mooz.github.io/org-js/) to render Org-mode results on the Web interface
+- [Markdown-it](https://github.com/markdown-it/markdown-it) to render Markdown results on the Web interface
--- a/docs/features.md
+++ b/docs/features.md
@ -1,13 +1,34 @@
 ## Features
- **Search**
-  - **Local**: Your personal data stays local. All search and indexing is done on your machine. *Unlike chat which requires access to GPT.*
+
+#### [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](./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
- **General**
+
+#### General
  - **Natural**: Advanced natural language understanding using Transformer based ML Models
  - **Pluggable**: Modular architecture makes it easy to plug in new data sources, frontends and ML models
  - **Multiple Sources**: Index your Org-mode and Markdown notes, PDF files, Github repositories, and Photos
-  - **Multiple Interfaces**: Interact from your [Web Browser](https://github.com/khoj-ai/khoj/blob/master/src/khoj/interface/web/index.html), [Emacs](https://github.com/khoj-ai/khoj/blob/master//src/interface/emacs/khoj.el) or [Obsidian](https://github.com/khoj-ai/khoj/blob/master/src/interface/obsidian/)
+  - **Multiple Interfaces**: Interact from your [Web Browser](./web.md), [Emacs](./emacs.md) or [Obsidian](./obsidian.md)
+
+### Supported Interfaces
+
+[![Khoj on Emacs](https://img.shields.io/badge/Emacs-%237F5AB6.svg?&style=for-the-badge&logo=gnu-emacs&logoColor=white)](./emacs.md)
+<span>&nbsp;</span>
+[![Khoj on Obsidian](https://img.shields.io/badge/Obsidian-%23483699.svg?style=for-the-badge&logo=obsidian&logoColor=white)](./obsidian.md)
+
+### Supported Data Sources
+- markdown*
+- org-mode*
+- pdf*
+- images*
+- [github](./github_integration.md)
+- [notion](./notion_integration.md)
+
+\* These data sources are offline only.
+
+If you're using Github or Notion, you can get on a waitlist for [Khoj Cloud](https://khoj.dev).