From f3c767dc6f6fc56a1a5a7ed3337e2da8a2bdeb4a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?C=C3=A9dric=20Krier?= <ced@b2ck.com>
Date: Fri, 2 Aug 2024 15:51:49 +0200
Subject: [PATCH] Update documentation of authentication SAML

---
 modules/authentication_saml/doc/index.rst                | 9 +++++----
 .../doc/{design.rst => reference.rst}                    | 6 +++---
 2 files changed, 8 insertions(+), 7 deletions(-)
 rename modules/authentication_saml/doc/{design.rst => reference.rst} (92%)

diff --git a/modules/authentication_saml/doc/index.rst b/modules/authentication_saml/doc/index.rst
index 9e65710cbe..9dbe508055 100644
--- a/modules/authentication_saml/doc/index.rst
+++ b/modules/authentication_saml/doc/index.rst
@@ -2,13 +2,14 @@
 Authentication SAML Module
 ##########################
 
-The `SAML <https://en.wikipedia.org/wiki/Security_Assertion_Markup_Language>`_
-authentication module allows to delegate the user authentication to an
-`identity provider <https://en.wikipedia.org/wiki/Identity_provider_(SAML)>`_.
+The *Authentication SAML Module* allows delegating the user authentication to
+an `identity provider
+<https://en.wikipedia.org/wiki/Identity_provider_(SAML)>`_ using `SAML
+<https://en.wikipedia.org/wiki/Security_Assertion_Markup_Language>`_.
 
 .. toctree::
    :maxdepth: 2
 
    configuration
-   design
+   reference
    releases
diff --git a/modules/authentication_saml/doc/design.rst b/modules/authentication_saml/doc/reference.rst
similarity index 92%
rename from modules/authentication_saml/doc/design.rst
rename to modules/authentication_saml/doc/reference.rst
index 12ee749839..4dedf0f4b2 100644
--- a/modules/authentication_saml/doc/design.rst
+++ b/modules/authentication_saml/doc/reference.rst
@@ -1,6 +1,6 @@
-******
-Design
-******
+*************
+API Reference
+*************
 
 The *Authentication SAML Module* introduces some new routes: