[no subject]

[Ludovic Courtès]

branch: master
commit 5ab13c5c88be882fda36365ef3af6f58f9a944f0
Author: Ludovic Courtès <ludo@gnu.org>
AuthorDate: Sun Oct 1 16:02:33 2023 +0200

    doc: Expand intro to the web API.
    
    * doc/cuirass.texi (Web API): Rename to…
    (Web Interface): … this.  Add introductory text.
---
 doc/cuirass.texi | 24 ++++++++++++++++++------
 1 file changed, 18 insertions(+), 6 deletions(-)

diff --git a/doc/cuirass.texi b/doc/cuirass.texi
index 72a40f8..69c58f7 100644
--- a/doc/cuirass.texi
+++ b/doc/cuirass.texi
@@ -59,7 +59,7 @@ Documentation License''.
 * Build modes::                 Build modes.
 * Invocation::                  How to run Cuirass.
 * Authentication::              Configuring TLS authentication.
-* Web API::                     Description of the Web API.
+* Web Interface::               Description of the Web API.
 * Database::                    About the database schema.
 
 * Contributing::                Your help needed!
@@ -830,11 +830,23 @@ should now only allow authenticated users to perform 
administrative
 tasks.
 
 @c *********************************************************************
-@node Web API
-@chapter Web API
-@cindex web api
-
-The Cuirass web API is inspired from the Hydra one.
+@node Web Interface
+@chapter Web Interface
+@cindex web API
+
+Cuirass has a web interface that one can navigate through a web browser,
+and it also has a programming interface: HTTP endpoints that can be
+queried to obtain a JSON representation of its state.
+
+This programming interface is inspired by that of Hydra, the continuous
+integration tool of the NixOS project.  The sections below describe the
+available HTTP endpoints.
+
+As a user, note that there are at least two tools that can simplify
+access to this interface: the
+@url{https://notabug.org/alezost/emacs-build-farm,
+@code{emacs-build-farm}} package for Emacs, and the @code{(guix ci)}
+client module from Guix.
 
 @section Evaluation information
 @subheading Single evaluation