Skip to content

Commit 68bbcd5

Browse files
committed
docs: add GFM remark
1 parent 21551e4 commit 68bbcd5

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ Use cases:
1616
## Docs
1717
The UML usage style in this project is _sketching_, as described by Marting Fowler e.g. _UML Distilled, Martin Fowler (2009)_. This basically means that it is used as a quick sketch to clarify ideas in broad strokes, and is neither intended to be kept up to date nor describe the project fully.
1818

19-
In a real-life scenario, I'd discuss with the team if they are conformable with this approach or if another is needed.
19+
> [!IMPORTANT]
20+
> In a real-life scenario, I'd discuss with the team if they are conformable with this approach or if another is needed.
2021
2122
### Documenting architectural, design or almost any decision made
2223

0 commit comments

Comments
 (0)