docs: improved index intro text, added webui docs

ErikBjare · Aug 9, 2024 · 041e8e8 · 041e8e8
1 parent 82f9eb1
commit 041e8e8
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 9 deletions.
diff --git a/docs/cli.rst b/docs/cli.rst
@@ -4,7 +4,3 @@ CLI Reference
 .. click:: gptme.cli:main
    :prog: gptme
    :nested: full
-
-.. click:: gptme.cli_server:main
-   :prog: gptme-server
-   :nested: full
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,16 +3,22 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to gptme's documentation!
-=================================
+gptme documentation
+===================
 
-This is the documentation for gptme.
+Welcome to the documentation for ``gptme``!
+
+``gptme`` is a tiny command-line application that allows you to interact with AI agent equipped with powerful local tools, acting as a copilot for your computer, via the terminal. It can execute python and bash, edit local files, search and browse the web.
+
+To get an understanding about how it works, the easiest way is to try it out yourself by following the :ref:`Getting Started` guide. If you want to see some examples of what you can do with it, check out the :ref:`Demos` and :ref:`Tools`.
+
+It is designed to be easy to use and extend, and can be used as a library or a standalone application. It also has a tiny :ref:`Web UI` with basic functionality.
+
+See the `README <https://github.com/ErikBjare/gptme/blob/master/README.md>`_ file for more general information about the project.
 
 .. note::
     This documentation site is still under construction.
 
-    In the meantime, see the `README <https://github.com/ErikBjare/gptme/blob/master/README.md>`_ file for more information.
-
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
@@ -21,6 +27,7 @@ This is the documentation for gptme.
    demos
    tools
    providers
+   webui
    finetuning
    cli
    api

diff --git a/docs/webui.rst b/docs/webui.rst
@@ -0,0 +1,19 @@
+Web UI
+======
+
+.. note::
+   The web UI is still in development and does not have all the features of the CLI.
+   It does not support streaming, doesn't ask for confirmation before executing, lacks the ability to interrupt generations, etc.
+
+gptme has a very minimalistic web UI, it can be started by running the following command:
+
+.. code-block:: bash
+
+    gptme-server
+
+You can then access the web UI by visiting http://localhost:5000 in your browser.
+
+
+.. click:: gptme.server.cli:main
+   :prog: gptme-server
+   :nested: full