{
"id": 2,
"links": [
1
],
"status": "decided"
}
2 — Documentation Web Site
Publish architectural decisions as ADR based web pages
Date: 2023-12-11 00:00:00 +0000 UTC
Status
Relates to:
Context
Because SeMoX is very much about data concepts and specifications in complex standardization scenarios it is important to treat documentation as our first class citizen. And maximize transparency it needs a dedicated web page providing full documentation, background and updates.
- It is important for domain experts which are non-technical
- Dissemination
Decision
We figured that the static site generator Hugo is a good tool for adopting documentation as code (which some of us call “code controlled documentation”) and publish it as a simple web page.
Consequences
Adopt Hugo and adopt some concepts from Docs as Code philosophy.