CSIT-744 Update report content for proper parsing

[csit.git] / docs / report / introduction / csit_design.rst

diff --git a/docs/report/introduction/csit_design.rst b/docs/report/introduction/csit_design.rst
index 0674c50..7798081 100644 (file)
--- a/docs/report/introduction/csit_design.rst
+++ b/docs/report/introduction/csit_design.rst
@@ -32,7 +32,7 @@ including CSIT framework is depicted in the figure below.
    :alt: FD.io CSIT system design\r
    :align: center\r
 \r
-   *Figure 1. FD.io CSIT system design*\r
+   *FD.io CSIT system design*\r
 \r
 A brief bottom-up description is provided here:\r
 \r
@@ -161,14 +161,15 @@ RF Keywords Naming Guidelines
 \r
 Readability counts: "..code is read much more often than it is written."\r
 Hence following a good and consistent grammar practice is important when\r
-writing RF KeyWords and Tests. All CSIT test cases are coded using\r
-Gherkin style and include only L2 KWs references. L2 KWs are coded using\r
-simple style and include L2 KWs, L1 KWs, and L1 python references. To\r
-improve readability, the proposal is to use the same grammar for both RF\r
-KW styles, and to formalize the grammar of English sentences used for\r
-naming the RF KWs. RF KWs names are short sentences expressing\r
-functional description of the command. They must follow English sentence\r
-grammar in one of the following forms:\r
+writing :abbr:`RF (Robot Framework)` KeyWords and Tests. All CSIT test cases\r
+are coded using Gherkin style and include only L2 KWs references. L2 KWs are\r
+coded using simple style and include L2 KWs, L1 KWs, and L1 python references.\r
+To improve readability, the proposal is to use the same grammar for both\r
+:abbr:`RF (Robot Framework)` KW styles, and to formalize the grammar of English\r
+sentences used for naming the :abbr:`RF (Robot Framework)` KWs. :abbr:`RF (Robot\r
+Framework)` KWs names are short sentences expressing functional description of\r
+the command. They must follow English sentence grammar in one of the following\r
+forms:\r
 \r
 #. **Imperative** - verb-object(s): *"Do something"*, verb in base form.\r
 #. **Declarative** - subject–verb–object(s): *"Subject does something"*, verb in\r
@@ -181,8 +182,8 @@ grammar in one of the following forms:
 Passive form MUST NOT be used. However a usage of past participle as an\r
 adjective is okay. See usage examples provided in the Coding guidelines\r
 section below. Following sections list applicability of the above\r
-grammar forms to different RF KW categories. Usage examples are\r
-provided, both good and bad.\r
+grammar forms to different :abbr:`RF (Robot Framework)` KW categories. Usage\r
+examples are provided, both good and bad.\r
 \r
 Coding guidelines\r
 -----------------\r