Release 3.0.0

CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased]
+## [3.0.0] – 2022-10-09
 
 ### Added
 
@@ -194,7 +194,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 First release of Markdown Architectural Decision Records.
 
-[Unreleased]: https://github.com/adr/madr/compare/3.0.0-beta.2...main
+[Unreleased]: https://github.com/adr/madr/compare/3.0.0...main
+[3.0.0]: https://github.com/adr/madr/compare/3.0.0-beta.2...3.0.0
 [3.0.0-beta.2]: https://github.com/adr/madr/compare/3.0.0-beta...3.0.0-beta.2
 [3.0.0-beta]: https://github.com/adr/madr/compare/2.1.2...3.0.0-beta
 [2.1.2]: https://github.com/adr/madr/compare/2.1.1...2.1.2

README.md

@@ -22,7 +22,7 @@ For user documentation, please head to <https://adr.github.io/madr/>.
 
 ## How to start Jekyll locally
 
-For rendedring the `docs` directory, Jekyll is needed.
+For rendering the `docs` directory, Jekyll is needed.
 
 For local development, follow the [Jekyll installation instructions](https://jekyllrb.com/docs/installation/).
 Installing the latest version of ruby followed by `gem install bundler` should be enough.
@@ -47,7 +47,7 @@ In case you get errors regarding `Gemfile.lock`, just delete `Gemfile.lock` and
 ## Releasing a new version
 
 1. Update `CHANGELOG.md`.
-2. Update the example at `docs/index.md`.
+2. Update the examples at `docs/index.md` and `docs/examples.md`.
 3. Update `docs/decisions/*` with the new template.
 4. Check that the YAML front matter in `docs/decisions/adr-template.md` is kept.
 5. Copy `.markdownlint.yml` to `template/.markdownlint.yml`

docs/decisions/0000-use-markdown-any-decision-records.md

@@ -11,15 +11,15 @@ Which format and structure should these records follow?
 
 ## Considered Options
 
-* [MADR](https://adr.github.io/madr/) 3.0.0-beta – The Markdown Any Decision Records
+* [MADR](https://adr.github.io/madr/) 3.0.0 – The Markdown Any Decision Records
 * [Michael Nygard's template](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions) – The first incarnation of the term "ADR"
 * [Sustainable Architectural Decisions](https://www.infoq.com/articles/sustainable-architectural-design-decisions) – The Y-Statements
 * Other templates listed at <https://github.com/joelparkerhenderson/architecture_decision_record>
 * Formless – No conventions for file format and structure
 
 ## Decision Outcome
 
-Chosen option: "MADR 3.0.0-beta", because
+Chosen option: "MADR 3.0.0", because
 
 * Implicit assumptions should be made explicit.
   Design documentation is important to enable people understanding the decisions later on.

docs/decisions/0016-outcome-before-detailed-pros-cons.md

@@ -70,3 +70,5 @@ Illustration:
 
 * Good, because the logical flow is kept
 * Bad, because the decision outcome is not close to the options
+* Bad, because "small" MADRs with the list of options and the decision outcome (and not containing the section "Pros and Cons of the Options")
+* Bad, because "small" MADRs with the list of options and the decision outcome (and not containing the section "Pros and Cons of the Options")

package.json

@@ -13,7 +13,7 @@
     "documentation",
     "markdown"
   ],
-  "version": "3.0.0-beta.2",
+  "version": "3.0.0",
   "homepage": "https://adr.github.io/madr/",
   "author": "Oliver Kopp (http://github.com/koppor/)",
   "contributors": [