chore(Documentation): Update for merge with main and address review feedback

Theme and Dependencies:
- Update adi-mkdocs-harmonic to v0.7.1 (latest stable release)
- Update pymdown-extensions requirement for compatibility

Content Updates:
- Add Unity Test Framework documentation to libraries.md
  - Ported from PR #1033 which was merged to main after original PR #1257
  - Includes on-target testing and host machine testing examples
  - Documents test build target and FreeRTOS integration

Link Fixes:
- Fix broken anchor link in libraries.md (visual-studio-code.md reference)
- Fix relative path in CONTRIBUTING.md (user-guide/index.md)
- Change from Documentation/user-guide/index.md to user-guide/index.md
  (path is relative to Documentation folder after build.py copies it)

Address Original PR #1257 Review Feedback:
- Remove redundant 'typical' wording in getting-started.md development cycle
  - Changed 'The typical development cycle typically' to 'The development cycle typically'
- Update Windows support from 'Windows 10 only' to 'Windows 10 and later'
  - Reflects current MSDK Windows 11 compatibility
- Remove proprietary licensing statement from mkdocs.yml copyright line
  - Deleted 'This software is proprietary to Analog Devices, Inc. and its licensors.'
  - Aligns with MSDK's permissive licensing

Cleanup:
- Remove accidentally committed .DS_Store files (macOS system files)

These changes ensure the resurrected PR builds cleanly, includes content
added to main since Nov 2024, and addresses all review feedback from the
original PR.

Author: carolinemaymaguirecmm

CONTRIBUTING.md

@@ -257,7 +257,7 @@ DoxyGen is automatically run across the MSDK code as part of the User Guide's bu
 
 ### User Guide
 
-The [MSDK User Guide](Documentation/user-guide/index.md) is maintained in the `Documentation/user-guide` folder.  This document contains higher-level usage info for the MSDK.  If a part, IDE, or library is supported by the MSDK then there should be some relevant info in the User Guide covering its setup, configuration, and usage.
+The [MSDK User Guide](user-guide/index.md) is maintained in the `Documentation/user-guide` folder.  This document contains higher-level usage info for the MSDK.  If a part, IDE, or library is supported by the MSDK then there should be some relevant info in the User Guide covering its setup, configuration, and usage.
 
 When writing markdown links, relative paths should always be used.  Additionally, links to local files on the user's filesystem **cannot** be used, since the online copy of the docs will throw a 404 on them.  See [Writing Your Docs](https://www.mkdocs.org/user-guide/writing-your-docs/) for more details.
 

Documentation/requirements.txt

@@ -1,3 +1,3 @@
 mkdocs >= 1.4.2
-adi-mkdocs-harmonic >= 0.7.0
+adi-mkdocs-harmonic == 0.7.1
 pymdown-extensions>=10.0.1

Documentation/user-guide/getting-started.md

@@ -1,6 +1,5 @@
 # Getting Started
-
-The MSDK is designed for both evaluation and end-application development. The typical **evaluation** cycle usually involves setting up the development environment, running demos, and exercising the peripheral driver API on an _evaluation platform_. The typical **development** cycle typically involves building a prototype application on an _evaluation platform_ first, then porting the application to a custom board. This section describes how to get started with the MSDK focusing on the _evaluation_ cycle.
+The MSDK is designed for both evaluation and end-application development. The typical **evaluation** cycle usually involves setting up the development environment, running demos, and exercising the peripheral driver API on an _evaluation platform_. The **development** cycle typically involves building a prototype application on an _evaluation platform_ first, then porting the application to a custom board. This section describes how to get started with the MSDK focusing on the _evaluation_ cycle.
 
 **First**, review the [**Key Concepts**](#key-concepts) below.  Then proceed to the section for your preferred IDE. Each subsection is a self-contained quick-start that includes links to additional documentation on important topics.
 

Documentation/user-guide/index.md

@@ -8,7 +8,7 @@ This document describes the MSDK's installation, setup, and usage.
 
 ## Supported Operating Systems
 
-* Windows (Windows 10 only)
+* Windows (Windows 10 and later)
 
 * Linux (Ubuntu only)
 

Documentation/user-guide/libraries.md

@@ -242,3 +242,138 @@ All parts in the MSDK support the Coremark library via a `Coremark` example appl
 
 ???+ note "ℹ️ **Note**"
     The source code of the `Coremark` examples are somewhat unique.  They only contain a `core_portme.c`/`core_portme.h`.  These files are provided by CoreMark libraries to give the MSDK an implementation layer for a few hardware-dependent functions.  Otherwise, the remainder of the source code (located in `Libraries/Coremark`) must remain unmodified to comply with the CoreMark rules.
+
+## Unity Test Framework
+
+The [Unity Test Project](https://github.com/ThrowTheSwitch/Unity) is a simple unit testing framework for C.  It can be used to run hardware-in-the-loop tests on MSDK microcontrollers, as well as more individual unit tests compiled and run on a developer's host machine to test less hardware-dependent software abstractions.
+
+See [Build Variables for Toggling Libraries](build-system.md#build-variables-for-toggling-libraries) for instructions on enabling the Unity Test framework.
+
+### Unity Test Supported Parts
+
+- All
+
+### Running Tests on a Target Micro
+
+The following code snippet shows how a simple sequence of tests might be run on a target microcontroller using the Unity test library.  Once unity is [enabled](build-system.md#build-variables-for-toggling-libraries), including the `"unity.h"` header file grants access to useful assertions and macros.  The project can then be [built and run](visual-studio-code.md#flash-run) like any other MSDK project.
+
+```C
+#include "unity.h"
+
+// *****************************************************************************
+int main(void)
+{
+    UnityBegin(__FILE__);
+
+    Unity.NumberOfTests++;
+    TEST_ASSERT_EQUAL(1 + 1, 2);
+
+    Unity.NumberOfTests++;
+    TEST_ASSERT_NOT_EQUAL(1 + 1, 0);
+
+    return (UnityEnd());
+}
+```
+
+The results of the test will be sent to the microcontroller's serial console output (defined by `CONSOLE_UART` in the [BSP](board-support-pkgs.md)), and can be viewed from a serial terminal.
+
+```serial
+-----------------------
+2 Tests 0 Failures 0 Ignored 
+OK
+```
+
+For a more comprehensive list of available assertions see the [Unity Assertions Documentation](https://github.com/ThrowTheSwitch/Unity/blob/master/docs/UnityAssertionsReference.md).
+
+### Running Tests on a Host Machine
+
+When the Unity Test framework is enabled, a new build target `test` becomes available.  When `make test` is run, it compiles the source code in the `test` sub-folder of the current project into a single binary that will run on the developer's host PC.  The test results are printed to the screen and a non-zero return code is passed to the host process in the case of any failures.  Currently, the tools are set up to do this with GCC.
+
+This is useful for developing unit-level testing for more abstract software.
+
+For example, assume there is a simple function for adding two `uint8_t` in the current project that we would like to unit test.
+
+```C
+// simple_code.c
+#include <stdint.h>
+
+uint8_t simple_add(uint8_t x, uint8_t y)
+{
+    return x + y;
+}
+```
+
+In the `test` folder of our project, we can implement the following tests in a file called `test_functions.c`
+
+```C
+// test/test_functions.c
+#include <stdint.h>
+#include "unity.h"
+
+// Adding an 'extern' declaration of the function to test gets this file access to it 
+extern uint8_t simple_add(uint8_t x, uint8_t y);
+
+// Utility functions for unit testing setup/clean-up.  Empty for this simple example.
+void setUp(void) {}
+void tearDown(void) {}
+
+// Validate that 'simple_add' 3+4 == 7
+void test_simple_add_ok(void)
+{
+    TEST_ASSERT_EQUAL(7, simple_add(3, 4));
+}
+
+// Check if 'simple_add' 3+4 == -1
+// In this case, we expect this to fail since we are using uint8_t
+void test_simple_add_fail(void)
+{
+    TEST_ASSERT_EQUAL(-1, simple_add(3, -4));
+}
+```
+
+A top-level `main` function for driving these test functions also needs to be written.  Unity features scripts for generating these top-level functions automagically (see the [Unity Helper Scripts Guide](https://github.com/ThrowTheSwitch/Unity/blob/master/docs/UnityHelperScriptsGuide.md)), or they can be written manually.  For this example, the output of the helper script looks as follows and is saved to the `test/test_runner.c` file.
+
+```C
+// test/test_runner.c
+// Test runner code
+// Header files
+#include "unity.h"
+
+// Test functions
+extern void test_simple_add_ok(void);
+extern void test_simple_add_fail(void);
+
+// Main function
+int main(void)
+{
+    UnityBegin(__FILE__);
+
+    RUN_TEST(test_simple_add_ok);
+    RUN_TEST(test_simple_add_fail);
+
+    return (UnityEnd());
+}
+```
+
+The test plan above can then be run on the developer's host PC with:
+
+```console
+$ make test
+
+>> host pc gcc output here <<
+
+running tests...
+test/test_runner.c:12:test_simple_add_ok:PASS
+test/test_runner.c:13:test_simple_add_fail:FAIL: Expected -1 Was 255
+
+-----------------------
+2 Tests 1 Failures 0 Ignored 
+FAIL
+
+>> ...and returns error code <<
+```
+
+Notice that the test returned a failure code as we expected (since the second test was intentionally broken to illustrate a unit test failure).
+
+???+ note "ℹ️ **Note**"
+    The test feature requires an OS-layer abstraction that provides functions like `malloc` and `free`.  By default, the test feature will attempt to use the [FreeRTOS](#freertos) OS layer if it's available.  Otherwise, it will use NewLib's implementation.  Custom OS layers can be implemented, but are currently outside the scope of this document.

mkdocs.yml

@@ -1,6 +1,6 @@
 site_name: Analog Devices MSDK Documentation
 site_author: Analog Devices, Inc.
-copyright: 'Copyright (C) 2022-2023 Maxim Integrated Products, Inc. All Rights Reserved. (now owned by Analog Devices, Inc.), Copyright (C) 2023-2024 Analog Devices, Inc. All Rights Reserved. This software is proprietary to Analog Devices, Inc. and its licensors.'
+copyright: 'Copyright (C) 2022-2023 Maxim Integrated Products, Inc. All Rights Reserved. (now owned by Analog Devices, Inc.), Copyright (C) 2023-2024 Analog Devices, Inc. All Rights Reserved.'
 repo_url: https://github.com/analogdevicesinc/msdk
 docs_dir: 'Documentation'
 site_dir: 'docs'