[taler-docs] 01/05: fix warnings, improve structure

[gnunet]

This is an automated email from the git hooks/post-receive script.

grothoff pushed a commit to branch master
in repository docs.

commit 614a17d5993fd98304adb8b45966cdbc3aa3d002
Author: Christian Grothoff <grothoff@gnunet.org>
AuthorDate: Wed May 8 09:38:03 2024 +0200

    fix warnings, improve structure
---
 core/api-bank-wire.rst                      |  2 ++
 core/api-common.rst                         |  5 +++++
 design-documents/023-taler-kyc.rst          | 10 +++++-----
 libeufin/index.rst                          |  1 +
 libeufin/regional-automated-manual.rst      |  1 -
 libeufin/regional-custom-manual.rst         |  1 -
 {frags => libeufin}/regional-manual-use.rst | 19 +++++++++++++++++++
 7 files changed, 32 insertions(+), 7 deletions(-)

diff --git a/core/api-bank-wire.rst b/core/api-bank-wire.rst
index 34658f01..84184ec9 100644
--- a/core/api-bank-wire.rst
+++ b/core/api-bank-wire.rst
@@ -440,9 +440,11 @@ Security Considerations
 =======================
 
 For implementors:
+
 * The withdrawal operation ID must contain enough entropy to be unguessable.
 
 Design:
+
 * The user must complete the 2FA step of the withdrawal in the context of 
their banking
   app or online banking Website.
   We explicitly reject any design where the user would have to enter a 
confirmation code
diff --git a/core/api-common.rst b/core/api-common.rst
index 521b2fc0..0e057814 100644
--- a/core/api-common.rst
+++ b/core/api-common.rst
@@ -255,6 +255,11 @@ hashed data. See `base32`_.
   // 32-byte hash code.
   type ShortHashCode = string;
 
+.. ts:def:: AccountAccessToken
+
+  // 32-byte nonce.
+  type AccountAccessToken = string;
+
 .. ts:def:: WireSalt
 
   // 16-byte salt.
diff --git a/design-documents/023-taler-kyc.rst 
b/design-documents/023-taler-kyc.rst
index 17ec4b7f..9caac24c 100644
--- a/design-documents/023-taler-kyc.rst
+++ b/design-documents/023-taler-kyc.rst
@@ -200,7 +200,7 @@ user for *voluntary* KYC processes related to attestation 
(#7365).
 Proposed Solution
 =================
 
-The main state of an account is represented by a set of `KycRules` (the
+The main state of an account is represented by a set of `KYC rules <KycRule>` 
(the
 `LegitimizationRuleSet`) which specify the current *rules* to apply to
 transactions involving the account. Rules can *exposed* to the account owner,
 or can be secret.  Each *rule* specifies certain *conditions* which, if met,
@@ -1154,11 +1154,11 @@ New endpoints
 
       // True if the account is under investigation by AML staff
       // after this decision.
-      to_investigate: bool;
+      to_investigate: boolean;
 
       // True if this is the active decision for the
       // account.
-      is_active: bool;
+      is_active: boolean;
 
     }
 
@@ -1270,7 +1270,7 @@ New endpoints
       new_rules: LegitimizationRuleSet;
 
       // True if the account should remain under investigation by AML staff.
-      keep_investigating: bool;
+      keep_investigating: boolean;
 
       // When was the decision made?
       decision_time: Timestamp;
@@ -1600,7 +1600,7 @@ AML programs are helper programs that can:
     // rule determines which set of measures will
     // be activated and thus become visible for the
     // user.
-    display_priority: integer;
+    display_priority: Integer;
 
     // True if the rule (specifically, operation_type,
     // threshold, timeframe) and the general nature of
diff --git a/libeufin/index.rst b/libeufin/index.rst
index c77255b0..4fd7668c 100644
--- a/libeufin/index.rst
+++ b/libeufin/index.rst
@@ -31,4 +31,5 @@ LibEuFin is a project providing free software tooling for 
European FinTech.
   bank-manual
   regional-automated-manual
   regional-custom-manual
+  regional-manual-use
   setup-ebics-at-postfinance
diff --git a/libeufin/regional-automated-manual.rst 
b/libeufin/regional-automated-manual.rst
index f416d1b9..39dfd3f6 100644
--- a/libeufin/regional-automated-manual.rst
+++ b/libeufin/regional-automated-manual.rst
@@ -241,7 +241,6 @@ manual setup and in the the manpage of 
``taler-exchange-offline``.
 
 .. include:: ../frags/regional-system-on.rst
 .. include:: ../frags/deploying-tos.rst
-.. include:: ../frags/regional-manual-use.rst
 
 
 Installing Updates
diff --git a/libeufin/regional-custom-manual.rst 
b/libeufin/regional-custom-manual.rst
index 7da39c96..4a347791 100644
--- a/libeufin/regional-custom-manual.rst
+++ b/libeufin/regional-custom-manual.rst
@@ -141,7 +141,6 @@ account with "CHF".
 
 .. include:: ../frags/regional-system-on.rst
 .. include:: ../frags/deploying-tos.rst
-.. include:: ../frags/regional-manual-use.rst
 
 
 Maintenance
diff --git a/frags/regional-manual-use.rst b/libeufin/regional-manual-use.rst
similarity index 85%
rename from frags/regional-manual-use.rst
rename to libeufin/regional-manual-use.rst
index 7566d622..ff9f38f8 100644
--- a/frags/regional-manual-use.rst
+++ b/libeufin/regional-manual-use.rst
@@ -1,3 +1,22 @@
+..
+  This file is part of GNU TALER.
+  Copyright (C) 2014-2024 Taler Systems SA
+
+  TALER is free software; you can redistribute it and/or modify it under the
+  terms of the GNU Affero General Public License as published by the Free 
Software
+  Foundation; either version 2.1, or (at your option) any later version.
+
+  TALER is distributed in the hope that it will be useful, but WITHOUT ANY
+  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+  A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more 
details.
+
+  You should have received a copy of the GNU Affero General Public License 
along with
+  TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
+
+  @author Florian Dold
+  @author Marcello Stanisci
+  @author Christian Grothoff
+
 .. _regional-use:
 
 Using the Regional Currency

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.