From 4acf5cfad3bdee6143ca78a4ee57035be8816329 Mon Sep 17 00:00:00 2001 From: Blake Freer <59676067+BlakeFreer@users.noreply.github.com> Date: Sun, 22 Dec 2024 20:58:24 -0500 Subject: [PATCH] Fix broken links and mkdocs warnings (#354) --- docs/docs/firmware/architecture/{README.md => README.txt} | 0 docs/docs/firmware/architecture/index.md | 2 +- docs/docs/firmware/project-structure/index.md | 4 ++-- 3 files changed, 3 insertions(+), 3 deletions(-) rename docs/docs/firmware/architecture/{README.md => README.txt} (100%) diff --git a/docs/docs/firmware/architecture/README.md b/docs/docs/firmware/architecture/README.txt similarity index 100% rename from docs/docs/firmware/architecture/README.md rename to docs/docs/firmware/architecture/README.txt diff --git a/docs/docs/firmware/architecture/index.md b/docs/docs/firmware/architecture/index.md index 1da166739..ffb35041c 100644 --- a/docs/docs/firmware/architecture/index.md +++ b/docs/docs/firmware/architecture/index.md @@ -187,7 +187,7 @@ The peripheral implementations are in the MCAL (Microcontroller Abstraction Laye With this structure, the developer can write platform-agnostic app level code using the shared `DigitalInput` interface, knowing that both platforms have a matching implementation. -Both the peripheral interface and implementations can be used by multiple projects. To see how they are used in project-specific code, continue to [Project Structure](project-structure/index.md). +Both the peripheral interface and implementations can be used by multiple projects. To see how they are used in project-specific code, continue to [Project Structure](../project-structure/index.md). ## Example: TMS Layers diff --git a/docs/docs/firmware/project-structure/index.md b/docs/docs/firmware/project-structure/index.md index dcd52d108..d03e877ff 100644 --- a/docs/docs/firmware/project-structure/index.md +++ b/docs/docs/firmware/project-structure/index.md @@ -27,7 +27,7 @@ We will __recreate the Blink project from scratch__ for multiple platforms. You !!! warning - Knowledge of our firmware architecture is assumed. Read the [Architecture](../architecture.md) article before continuing. + Knowledge of our firmware architecture is assumed. Read the [Architecture](../architecture/index.md) article before continuing. !!! note @@ -59,7 +59,7 @@ You should now have the following directory structure. ## Bindings contract -A key feature of our firmware architecture is the complete abstraction of the app-level code from any specific platform implementation (See the [Architecture](../architecture.md) article). The two layers are interfaced by the "bindings" contract which we will write first. +A key feature of our firmware architecture is the complete abstraction of the app-level code from any specific platform implementation (See the [Architecture](../architecture/index.md) article). The two layers are interfaced by the "bindings" contract which we will write first. Create a new file `bindings.hpp` in the project directory. This is a header file since it only _declares_ the interface objects and methods rather than using or implementing them.