syntasso / kratix-docs

1 stars 8 forks source link

chore: clearly mark where code examples start and end in workshop #147

Closed SaphMB closed 2 weeks ago

SaphMB commented 3 weeks ago

We have received feedback that, when showing examples of what the promise.yaml should look like like, it is not immediately clear what content should come before and r,=or the snippet presented. Specifically, it can be hard to tell whether the content presented marks the end of the file.

For example:

Image

Acceptance Given access to the kratix workshop When I review any snippet of the promise.yaml Then I see a comment clearly marking whether more content should follow the snippet