yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs(adrs): move decision folder into docs to make them publicly visible within docs

Browse Source
This commit is contained in:
Johannes Kirschbauer
2025-05-14 10:06:24 +02:00
parent 5a7c49ad82
commit a1d2948914
7 changed files with 37 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/site/decisions/README.md Normal file
View File

@@ -0,0 +1,16 @@
# Architecture Decision Records
This section contains the architecture decisions that have been reviewed and generally agreed upon
## What is an ADR?
> An architecture decision record (ADR) is a document that captures an important architecture decision made along with its context and consequences.
!!! Note
For further reading about adr's we recommend [architecture-decision-record](https://github.com/joelparkerhenderson/architecture-decision-record)
## Crafting a new ADR
1. Use the [template](./_template.md)
2. Create the Pull request and gather feedback
3. Retreive your adr-number (see: [numbering](./03-adr-numbering-process.md))