Merge pull request #115 from fractalego/new-version

corrected typo in docs

documentation/build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 22b8ac47d6a20d5a564a037d5d2b9610
+config: 2564bb5b18e6d654866b2c94015027be
 tags: 645f666f9bcd5a90fca523b33c5a78b7

documentation/build/html/_sources/index.rst.txt

@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to WAFL's 0.0.80 documentation!
+Welcome to WAFL's 0.1.0 documentation!
 =======================================
 
 .. toctree::
@@ -16,6 +16,8 @@ Welcome to WAFL's 0.0.80 documentation!
    configuration
    running_WAFL
    facts_and_rules
+   indexing_files
+   modify_the_prompt
    examples
    testcases
    actions

documentation/build/html/_sources/installation.rst.txt

@@ -24,9 +24,10 @@ After installing the requirements, you can initialize the interface by running t
 .. code-block:: bash
 
     $ wafl init
+    $ wafl run
 
-which creates a `config.json` file that you can edit to change the default settings.
-A standard rule file is also created as `wafl.rules`.
+The first command creates a set of template files, including a configuration in `config.json` that you can edit to change the default settings.
+The second command starts the audio interface as well as a web server on port 8090 by default.
 Please see the examples in the following chapters.
 
 
@@ -42,13 +43,6 @@ In order to quickly run the LLM side, you can use the following installation com
 
     which will use the default models and start the server on port 8080.
 
-Alternatively, a Docker image can be used to run it as in the following:
-
-.. code-block:: bash
-
-    $ docker run -p8080:8080 --env NVIDIA_DISABLE_REQUIRE=1 --gpus all fractalego/wafl-llm:0.80
-
-
 The interface side has a `config.json` file that needs to be filled with the IP address of the LLM side.
 The default is localhost.
 

documentation/build/html/_sources/running_WAFL.rst.txt

@@ -3,6 +3,12 @@ Running WAFL
 This document contains a few examples of how to use the `wafl` CLI.
 There are four modes in which to run the system
 
+$ wafl run
+----------
+Starts the available interfaces of the chatbot at the same time.
+This is equivalent to running run-audio and run-server in parallel (see below).
+
+
 $ wafl run-audio
 ----------------
 
@@ -14,7 +20,7 @@ The default name is "computer", but you can change it to whatever you want.
 $ wafl run-server
 -----------------
 
-It runs a local web server that listens for HTTP requests on port 8889.
+It runs a local web server that listens for HTTP requests on port 8090.
 The server will act as a chatbot, executing commands and returning the result as defined in the rules.
 
 

documentation/build/html/_static/basic.css

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -237,6 +237,10 @@ a.headerlink {
     visibility: hidden;
 }
 
+a:visited {
+    color: #551A8B;
+}
+
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
 h3:hover > a.headerlink,
@@ -670,6 +674,16 @@ dd {
     margin-left: 30px;
 }
 
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;
@@ -738,6 +752,14 @@ abbr, acronym {
     cursor: help;
 }
 
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {

documentation/build/html/_static/doctools.js

@@ -4,7 +4,7 @@
  *
  * Base JavaScript utilities for all Sphinx HTML documentation.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

documentation/build/html/_static/documentation_options.js

@@ -1,5 +1,4 @@
-var DOCUMENTATION_OPTIONS = {
-    URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
+const DOCUMENTATION_OPTIONS = {
     VERSION: '',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,

documentation/build/html/_static/language_data.js

@@ -5,15 +5,15 @@
  * This script contains the language-specific data used by searchtools.js,
  * namely the list of stopwords, stemmer, scorer and splitter.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
 
 var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
 
 
-/* Non-minified version is copied as a separate JS file, is available */
+/* Non-minified version is copied as a separate JS file, if available */
 
 /**
  * Porter Stemmer