[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/elisa a3d6d06fa6 14/98: Add info how ELISA works into d
From: |
ELPA Syncer |
Subject: |
[elpa] externals/elisa a3d6d06fa6 14/98: Add info how ELISA works into docs |
Date: |
Wed, 17 Jul 2024 18:58:00 -0400 (EDT) |
branch: externals/elisa
commit a3d6d06fa63654be664ab693345cc8bf63ec1d6e
Author: Sergey Kostyaev <kostyaev.sergey2@wb.ru>
Commit: Sergey Kostyaev <kostyaev.sergey2@wb.ru>
Add info how ELISA works into docs
---
README.org | 7 +++++++
elisa.el | 7 +++++++
2 files changed, 14 insertions(+)
diff --git a/README.org b/README.org
index ce33131b88..28a9aed2af 100644
--- a/README.org
+++ b/README.org
@@ -12,6 +12,13 @@ answering a question, ELISA ensures that users have easy
access to
additional information on the topic, making it an essential tool
for both beginners and advanced Emacs users.
+ELISA creates index from info manuals. When you send message to
+~elisa-chat~ it search to semantically similar info nodes in index,
+get first ~elisa-limit~ nodes, add it to context and send your message
+to llm. LLM generates answer to your message based on provided
+context. You can read not only answer generated by llm, but also info
+manuals by provided links.
+
** Installation
You need emacs 29.2 or newer to use this package. Will be on package
diff --git a/elisa.el b/elisa.el
index deda0e1d66..648b60b868 100644
--- a/elisa.el
+++ b/elisa.el
@@ -35,6 +35,13 @@
;; additional information on the topic, making it an essential tool
;; for both beginners and advanced Emacs users.
;;
+;; ELISA creates index from info manuals. When you send message to
+;; `elisa-chat' it search to semantically similar info nodes in index,
+;; get first `elisa-limit' nodes, add it to context and send your
+;; message to llm. LLM generates answer to your message based on
+;; provided context. You can read not only answer generated by llm,
+;; but also info manuals by provided links.
+;;
;;; Code:
(require 'ellama)
- [elpa] externals/elisa 55200f8d8b 89/98: Fix readme markup for github rendering, (continued)
- [elpa] externals/elisa 55200f8d8b 89/98: Fix readme markup for github rendering, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa 21048a5033 91/98: Add melpa stable badge, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa fe93e52d2a 95/98: Review fixes, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa 56bc22a8c3 96/98: Improve package documentation, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa c842f1ce32 98/98: Bump version, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa f3d21b65d4 04/98: Fill readme with simple use case, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa 126def8ac8 02/98: Add license file, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa c2532617c9 11/98: Fix mistral model name, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa a59a3cd130 12/98: Add news, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa 260504512f 13/98: Add information about creating index into docs, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa a3d6d06fa6 14/98: Add info how ELISA works into docs,
ELPA Syncer <=
- [elpa] externals/elisa 261aae5b2e 15/98: Add CI, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa ba1633ba07 17/98: Merge pull request #1 from s-kostyaev/add-ci, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa dac7f7e184 18/98: Refactor asyncronous parsing, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa 2cafe8ae2c 19/98: Merge pull request #4 from s-kostyaev/fix-elpaca-installation, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa 05efc8eb0d 20/98: Bump version, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa ed1299a8aa 23/98: Bump version, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa 5d62cf3803 24/98: Reopen db after download sqlite extensions, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa 9a6dfa678b 25/98: Add info about downloading sqlite extensions into docs, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa 7f5a5fff5d 26/98: Fix CI warnings, ELPA Syncer, 2024/07/17
- [elpa] externals/elisa 48d96a9716 27/98: Merge pull request #5 from s-kostyaev/fix-load-file, ELPA Syncer, 2024/07/17