Skip to content

Commit

Permalink
Fix broken links and mkdocs warnings (#354)
Browse files Browse the repository at this point in the history
  • Loading branch information
BlakeFreer authored Dec 23, 2024
1 parent e86eb56 commit 4acf5cf
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/docs/firmware/architecture/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/firmware/project-structure/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.

Expand Down

0 comments on commit 4acf5cf

Please sign in to comment.