A single source of truth for audit explanations? #139
funnelfiasco
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
In thinking about both #125 and #73, I wonder if there's an opportunity to address them both by putting the content in per-audit yaml files (or some other structured format). Then the
--explain
could use the same text as the docs without having to maintain copies in two places.The downsides:
Another option would be to only pull a name and short description from the yaml to feed into
--explain
and the docs and have the rest of the docs be in existing markdown files. This solves point 3 above, but not really 1 or 2.The entire idea might be way beyond the reasonable value of "worth it", but I thought I'd kick the idea around for discussion.
Beta Was this translation helpful? Give feedback.
All reactions