diff --git a/docs/decisions/0001-use-CC0-or-MIT-as-license.md b/docs/decisions/0001-use-CC0-or-MIT-as-license.md index 09ec7aa..7ea6268 100644 --- a/docs/decisions/0001-use-CC0-or-MIT-as-license.md +++ b/docs/decisions/0001-use-CC0-or-MIT-as-license.md @@ -23,25 +23,25 @@ We want to have MADR used without any hassle and that users can just go ahead an ## Decision Outcome -Chosen option: "Dual license", because this lets users choose whether CC0 or MIT fits better on their work. +Chosen option: "Dual license with MIT and CC0", because this lets users choose whether CC0 or MIT fits better on their work. ## Pros and Cons of the Options -## CC0 +### CC0 * Good, because this license donates the content to "public domain" and does so as legally as possible. * Bad, because it does not contain attribution - and [attribution is important](https://opensource.stackexchange.com/a/9126/5671). -## BSD3 +### BSD3 * Bad, because it [is unclear whether it can be used for documentation](https://opensource.stackexchange.com/a/9545/5671) -## MIT +### MIT * Good, because it [explicitly may be used for documentation](https://opensource.stackexchange.com/a/9545/5671) * Good, because it is lean. -## Dual license with MIT and CC0 +### Dual license with MIT and CC0 With the SPDX identifier `MIT OR CC0-1.0`, the receiver of the documents can decide which license thay want to use. diff --git a/docs/decisions/0012-use-curly-braces-to-denote-placeholder.md b/docs/decisions/0012-use-curly-braces-to-denote-placeholder.md index fb695bc..1e1b347 100644 --- a/docs/decisions/0012-use-curly-braces-to-denote-placeholder.md +++ b/docs/decisions/0012-use-curly-braces-to-denote-placeholder.md @@ -52,7 +52,7 @@ Idea taken from +Example: ``. * Good, because feels "natural" in direct Markdown editing * Bad, because it does not render in HTML diff --git a/docs/decisions/0013-use-yaml-front-matter-for-meta-data.md b/docs/decisions/0013-use-yaml-front-matter-for-meta-data.md index fcaf645..738b3fb 100644 --- a/docs/decisions/0013-use-yaml-front-matter-for-meta-data.md +++ b/docs/decisions/0013-use-yaml-front-matter-for-meta-data.md @@ -26,7 +26,7 @@ Chosen option: "Use YAML front matter", because comes out best (see below). ## Pros and Cons of the Options -## Use YAML front matter +### Use YAML front matter Example: @@ -37,7 +37,7 @@ decision-makers: date: --- -## Context and problem statement +### Context and problem statement We want to record architectural decisions made in this project. Which format and structure should these records follow? @@ -54,7 +54,7 @@ Rendered output: * Bad, because rendering not standardized * Bad, because not all Markdown parsers can parse it -## Use plain Markdown everywhere +### Use plain Markdown everywhere * Good, because all parsers can handle it * Bad, because special markdown parsing tooling is needed