Restructure docs for new website (#3036)

---------

Co-authored-by: chammard <[email protected]>

.github/actions/markdown-check/mlc-config.json

@@ -5,16 +5,9 @@
       },
       {
         "pattern": "https?://"
-      }
-    ],
-    "replacementPatterns": [
-      {
-        "pattern": "^[./]*api/cmake/",
-        "replacement": "https://nasa.github.io/fprime/UsersGuide/api/cmake/"
       },
       {
-        "pattern": "^[./]*api/c\\+\\+/",
-        "replacement": "https://nasa.github.io/fprime/UsersGuide/api/c++/"
+        "pattern": "./tutorials-"
       }
     ]
 }

.github/actions/spelling/excludes.txt

@@ -136,3 +136,4 @@ ignore$
 ^docs/doxygen/mainpage.md$
 ^\Qcmake/test/data/test-implementations/Deployment/TestModule/Empty.cpp\E$
 ^\Qcmake/test/data/test-implementations/test-platforms/library.cmake\E$
+mkdocs.yml

.github/actions/spelling/expect.txt

@@ -195,7 +195,7 @@ DDDTHH
 ddl
 ddmm
 dealloc
-debian
+Debian
 deconstructor
 Deerin
 defaultgen

.github/workflows/markdown-link-check.yml

@@ -2,7 +2,7 @@ name: Check Markdown links
 
 on: 
   push:
-    branches: [devel]
+    branches: [devel, docs/new-website]
   pull_request:
     branches: [devel]
 
@@ -11,6 +11,14 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v4
+
+    - uses: ./.github/actions/setup
+
+    - name: 'Generate Doxygen and CMake docs'
+      run: |
+        sudo apt-get install -y doxygen
+        ./docs/doxygen/generate_docs.bash
+
     - uses: gaurav-nelson/github-action-markdown-link-check@v1
       with:
           use-quiet-mode: 'yes'

.gitignore

@@ -84,3 +84,5 @@ depend
 /venv/
 
 Packet-Views
+docs/documentation/reference/api/cpp
+docs/documentation/reference/api/cmake

Autocoders/Python/README.md

@@ -135,8 +135,7 @@ Cmake file that is present in all parts of directory tree to be built by cmake.
 
 ### Requirements
 
-The Autocoder's requirements are covered by installing the F´ software package. This is covered by the install document 
-found at: [INSTALL.md](../../docs/INSTALL.md).
+The Autocoder's requirements are covered by installing the F´ software package. This is covered by the installation process.
 
 ## Schematron
 In Autocoders/Python/schema/default there are various schematron .rng files mixed with the normal F Prime RelaxNG .rng schema files. The schematron files validate xml in the same way as the RelaxNG schemas (within the XmlParser classes), but these schematron files will only generate command line errors, not exceptions like the schema files will. Here is a short description of each file:

CONTRIBUTING.md

@@ -7,9 +7,6 @@ through how to contribute and the process contributions follow. Remember, we may
 your submission the best it can be. Fear not! Your submission is still valued! You may even comment on other submissions
 to help them improve.
 
-Make sure to review our [style guidelines](./docs/UsersGuide/dev/code-style.md) when developing code to ensure it meets
-the standards for F´´
-
 ## Ways of Contributing
 
 The best way to contribute to F´ is to remain positive and engaged. Just about every contribution needs some improvement
@@ -45,8 +42,7 @@ To contribute to the F´ framework directly, consider writing
 [needed documentation](https://github.com/nasa/fprime/issues?q=is%3Aissue+is%3Aopen+label%3ADocumentation) or starting
 with an [easy first issue](https://github.com/nasa/fprime/issues?q=is%3Aissue+is%3Aopen+label%3A%22Easy+First+Issue%22).
 When starting to modify F´ directly, ask questions, seek help, and be patient. Remember to review the project structure,
-development process, and helpful tips sections below. Following the
-[style guidelines](./docs/UsersGuide/dev/code-style.md) is a must for contributing code to F´.
+development process, and helpful tips sections below.
 
 ## Project Structure
 

Fw/Dp/docs/sdd.md

@@ -6,7 +6,7 @@
 This build module defines FPP ports and C++ classes that support
 the collection and storage of data products.
 For more information on data products and records, see the
-[data products documentation](../../../docs/Design/data-products.md).
+[data products documentation](../../../docs/documentation/user-manual/design/data-products.md).
 
 ## 2. Configuration
 

README.md

@@ -17,7 +17,7 @@ F´ (F Prime) is a component-driven framework that enables rapid development and
 - A growing collection of ready-to-use components
 - Testing tools for testing flight software at the unit and integration levels.
 
-Learn more about F' key features [here](https://nasa.github.io/fprime/features.html).
+Learn more about F´ key features [here](https://nasa.github.io/fprime/features.html).
 
 
 ## System Requirements

RPI/README.md

@@ -39,7 +39,7 @@ If the UART port is not set up correctly, there will be a file open error.
 
 **Install the packages necessary to run the demo.** 
 
-Please see [INSTALL.md](../docs/INSTALL.md) to ensure that the F´ application has been installed and tested with the basic Ref. Additionally, the
+Please see [install guide](../docs/getting-started/installing-fprime.md) to ensure that the F´ application has been installed and tested with the basic Ref. Additionally, the
 cross-compilers need to be installed. This is done by installing the `gcc-arm-linux-gnueabihf` and `g++-arm-linux-gnueabihf` packages on the host
 system. This is shown on Ubuntu below.
 
@@ -52,7 +52,7 @@ sudo apt update && sudo apt install -y gcc-arm-linux-gnueabihf g++-arm-linux-gnu
 
 **Crosscompiling using CMake:**
 
-The following commands are described at length in the getting started [tutorial](../docs/Tutorials/README.md). These commands will
+The following commands are described at length in the [HelloWorld tutorial](../docs/documentation/tutorials/). These commands will
 go to the RPI directory and generate a build directory for the RPI example. This step generates a CMake Cache, sets the toolchain use to build the
 code and does an initial scan of the source tree. Since the RPI example sets a default F´ toolchain file in its CMakeLists.txt, we do not need to 
 supply one on the command line when generating the build. This only needs to be done once to prepare for the build because CMake will detect

Ref/README.md

@@ -10,7 +10,7 @@ Understanding the reference application has a few minimal prerequisites.
 
 **Installing F´**
 
-Please follow the install guide for F´ found here: [INSTALL.md](../docs/INSTALL.md).
+Please follow the [install guide for F´](../docs/getting-started/installing-fprime.md).
 
 ## Building and Running the Ref Application
 
@@ -63,7 +63,5 @@ cd fprime/Ref/build-artifacts/<platform>/bin/
 - The F´ utility's build command can build individual components too.
 - The 'generate' command can take a toolchain argument for quickly generating a cross-compile `fprime-util generate raspberrypi` for example.
 
-Further work with the F´ utility can be found in the [Getting Started](../docs/Tutorials/README.md) tutorial. Other tutorials
-for many aspects of F´ are available [here](../docs/Tutorials/README.md).
-
+Further work with the F´ utility can be found in the [HelloWorld tutorial](../docs/documentation/tutorials/) tutorial.
 

cmake/API.cmake

@@ -503,7 +503,7 @@ endfunction(register_fprime_ut)
 #
 # This function allows users to register custom build targets into the build system.  These targets are defined in a
 # CMake file and consist of three functions that operate on different parts of the build: global, per-module, and
-# per-deployment. See: [Targets](targets.md).
+# per-deployment. See: [Targets](./target/target.md).
 #
 # This function takes in either a file path to a CMake file defining targets, or an short include path that accomplishes
 # the same thing. Note: make sure the directory is on the CMake include path to use the second form. The supplied file
@@ -571,7 +571,6 @@ endmacro(register_fprime_list_helper)
 # 1. Call one of `autocoder_setup_for_individual_sources()` or `autocoder_setup_for_multiple_sources()` from file scope
 # 2. Implement `<autocoder name>_is_supported(AC_POSSIBLE_INPUT_FILE)` returning true the autocoder processes given source 
 # 3. Implement `<autocoder name>_setup_autocode AC_INPUT_FILE)` to run the autocoder on files filter by item 2. 
-# See: [Autocoders](dev/autocoder_integration.md).
 #
 # This function takes in either a file path to a CMake file defining an autocoder target, or an short include path that accomplishes
 # the same thing. Note: make sure the directory is on the CMake include path to use the second form.
@@ -676,11 +675,10 @@ endfunction()
 
 #### Documentation links
 # Next Topics:
-#  - Setting Options: [Options](Options.md) are used to vary a CMake build.
-#  - Adding Deployments: [Deployments](deployment.md) create fprime builds.
+#  - Setting Options: [Options](options.md) are used to vary a CMake build.
 #  - Adding Modules: [Modules](module.md) register fprime Ports, Components, etc.
-#  - Creating Toolchains: [Toolchains](toolchain.md) setup standard CMake Cross-Compiling.
-#  - Adding Platforms: [Platforms](platform.md) help fprime set Cross-Compiling specific items.
-#  - Adding Targets: [Targets](targets.md) for help defining custom build targets
-#  - Implementation Packages Design: [Implementation Packages](/Design/package-implementor.md)
+#  - Creating Toolchains: [Toolchains](../../../user-manual/cmake/cmake-toolchains.md) setup standard CMake Cross-Compiling.
+#  - Adding Platforms: [Platforms](../../../user-manual/cmake/cmake-platforms.md) help fprime set Cross-Compiling specific items.
+#  - Adding Targets: [Targets](./target/target.md) for help defining custom build targets
+#  - Implementation Packages Design: [Implementation Packages](../../../user-manual/design/package-implementations.md)
 ####

cmake/platform/platform.cmake

@@ -2,7 +2,7 @@
 # platforms:
 #
 # Platforms in F prime's CMake system setup f prime specific items w.r.t the OS. This file loads those platforms
-# file and uses it to setup F prime's build. See: [Platform Template](./platform/platform-template.md) for how to
+# file and uses it to setup F prime's build. See: [Platform Template](./platform-template.md) for how to
 # generate these files.
 #
 ####

cmake/platform/platform.cmake.template

@@ -9,7 +9,7 @@
 # to remove the platform-failsafe (step 1) and fill in all <SOMETHING> tags.
 #
 # **Note:** If the user desires to set compiler paths, and other CMake toolchain settings, a
-#           toolchain file should be constructed. See: [toolchain.md](toolchain.md)
+#           toolchain file should be constructed. See: toolchain.md
 #
 # ### Platform File Loading ###
 #

cmake/sub-build/sub-build.cmake

@@ -5,7 +5,7 @@
 # implemented in this file. This includes the ability to setup targets, builds, and handle information passing back and
 # forth between the modules.
 #
-# This file runs CMake on fprime, but registering only a set of target: (e.g. [fpp_locs](./target/fpp_locs.cmake) that
+# This file runs CMake on fprime, but registering only a set of target: (e.g. fpp_locs that
 # do the work on the build. This allows CMake to generate build information to be consumed at the generate phase while
 # maintaining the efficiency of properly expressed builds.
 ####

cmake/test/data/test-implementations/test-platforms/cmake/platform/Linux.cmake

@@ -1,7 +1,7 @@
 ####
 # Linux.cmake:
 #
-# Linux platform file for standard linux targets. Merely defers to [./Linux-common.cmake](Linux-common.cmake).
+# Linux platform file for standard linux targets. Merely defers to ./Linux.cmake.
 ####
 include("${FPRIME_FRAMEWORK_PATH}/cmake/platform/Linux.cmake")
 choose_fprime_implementation(Test/Implementation Test/Implementation/Platform)

cmake/toolchain/toolchain.cmake.template

@@ -12,7 +12,7 @@
 # https://cmake.org/cmake/help/v3.12/manual/cmake-toolchains.7.html
 #
 # **Note:** If the user desires to set compile flags, or F prime specific build options, a platform
-#           file should be constructed. See: [platform.md](platform.md)
+#           file should be constructed. See: [platform.md](../platform/platform.md)
 #
 # ### Filling In CMake Toolchain by Example ###
 #