Final tweaks to General chapter (#66)

ARM-software · Oct 11, 2024 · fb30da5 · fb30da5
1 parent 65b82f6
commit fb30da5
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/Documentation/Doxygen/General/src/General.md b/Documentation/Doxygen/General/src/General.md
@@ -1,6 +1,6 @@
 # Overview {#mainpage}
 
-The free-to-use **MDK-Middleware** contains software components for IPv4 and IPv6 networking, USB Host and Device
+The **MDK-Middleware** contains software components for IPv4 and IPv6 networking, USB Host and Device
 communication, and file system for data storage. The components can for example be used by the user's application, IoT
 connectors for cloud connectivity, or the \urlout{SDS}.
 
@@ -37,10 +37,11 @@ MDK-Middleware components are available as source code and will work with all ma
 
 ## Documentation Structure {#mw_using_mw}
 
-This user's guide contains the following chapters:
+This chapter contains the following sections:
 
-- \ref mw_using_generic_steps explains the necessary steps to create from scratch a project containing a Middleware component.
-- \ref mw_using_stack_and_heap describes how to configure a project to meet the resource requirements of the Middleware.
+- [Revision History](revision_history.md) contains an overview of the revisions.
+- [Using Middleware](using_mw.md) explains the steps to create from scratch a project containing a Middleware component and how configure resources.
+- [Working with Examples](work_with_examples.md) explains how to run the device-agnostic middleware reference applications on boards.
 
 Every middleware component has a section on the following topics to explain how to create an application:
 

diff --git a/Documentation/Doxygen/General/src/revision_history.md b/Documentation/Doxygen/General/src/revision_history.md
@@ -1,5 +1,9 @@
 # Revision History {#rev_hist}
 
+> **Note:**
+>
+> - Refer to [Version History](https://www.keil.arm.com/packs/mdk-middleware-keil/versions/) of the Software Pack for a detailed list of the changes.
+
 <table class="cmtable" summary="Revision History">
   <tr>
     <th>Version</th>

diff --git a/Documentation/Doxygen/General/src/work_with_examples.md b/Documentation/Doxygen/General/src/work_with_examples.md
@@ -1,4 +1,4 @@
-# Working with MDK-Middleware Examples {#working_with_examples}
+# Working with Examples {#working_with_examples}
 
 The MDK-Middleware examples are implemented as [CMSIS-Toolbox Reference Applications](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/ReferenceApplications.md)
 that use [CMSIS-Driver](https://arm-software.github.io/CMSIS_6/latest/Driver/index.html) interfaces. These Reference Applications are hardware agnostic and need to be extended with a compatible [board layer](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/ReferenceApplications.md#board-layer) to run on a specific hardware target.