Fix markdown lint errors

This commit is contained in:
William Sandner
2023-03-24 17:29:16 +01:00
parent 0d20f4e5b1
commit c504fc26da
50 changed files with 702 additions and 637 deletions

View File

@@ -1,5 +1,5 @@
<!-- markdownlint-disable-next-line first-line-h1 -->
<!-- markdownlint-disable-next-line MD041 -->
##### Project
::[PROJECT-NAME](Home)
@@ -31,7 +31,7 @@
This design document describes a system that will satisfy the requirements of the [SRS](SRS). Decisions made in creating this design document are based on those requirements and an understanding of available technologies and components. Once the design has been drafted, work on the system implementation and unit testing may begin.
*TODO: Fill in the sections below. Add ore remove items as needed for your project.*
_TODO: Fill in the sections below. Add ore remove items as needed for your project._
### Introduction
@@ -59,8 +59,8 @@ interface and database design.
### UML Structural Design
*TODO: Link to a design model and/or design diagrams that describe your
system's structure in detail.*
_TODO: Link to a design model and/or design diagrams that describe your
system's structure in detail._
#### The system's structural design is described in the following UML model
@@ -81,8 +81,8 @@ system's structure in detail.*
### UML Behavioral Design
*TODO: Link to a design model and/or design diagrams that describe your
system's behavior in detail.*
_TODO: Link to a design model and/or design diagrams that describe your
system's behavior in detail._
#### The system's behavioral design is described in the following UML model
@@ -107,10 +107,10 @@ system's behavior in detail.*
### UML Design Checklist
*TODO: Answer the following questions to help evaluate your design. Add
_TODO: Answer the following questions to help evaluate your design. Add
or remove questions to fit your project. If you cannot answer a question
positively, that may indicate an aspect of the design that should be
revised.*
revised._
#### Correctness: How do you know that this design is correct?
@@ -148,4 +148,4 @@ revised.*
- ::Yes, everyone understands. Feedback is welcome.
- ::No, this is a risk that is noted in the
[Risk Management](Project-Plan#Risk-Management) section.
[Risk Management](Project-Plan#Risk-Management) section.