search

compliance-framework / docs

0 stars 0 forks source link

Documentation improvements #10

Open onselakin opened 1 year ago

onselakin commented 1 year ago

https://github.com/compliance-framework/website/blob/main/sequence_diagrams/CONFIGURATION_DIAGRAMS.md#:~:text=How%20does%20a%20Job%20Spec%20gets%20generated

These sequence diagrams, and possibly others, need documentation. Relying solely on the diagrams might not help people understand the concepts.

gusfcarvalho commented 1 year ago

We might want to be more specific here - I'm not sure if people would be able to get exactly what good looks like :)

onselakin commented 1 year ago

I believe we can close this one because the diagrams on this page have already been improved and distributed into the relevant pages.