Generate documentation on the deployments from the code #89

New issue

Open

opened 2025-01-31 11:00:04 +01:00 by fricklerhandwerk · 0 comments

fricklerhandwerk commented

2025-01-31 11:00:04 +01:00

Owner

Right now the README hardcodes how machines are used and for which deployments. This will go out of date very quickly.

We already have this information as structured data being used for the actual deployments right there in our source code. Generate the README from that code, e.g. using a pre-commit hook that is backed by a CI check

Right now the README hardcodes how machines are used and for which deployments. This will go out of date very quickly. We already have this information as structured data being used for the actual deployments right there in our source code. Generate the README from that code, e.g. using a pre-commit hook that is backed by a CI check