-
Notifications
You must be signed in to change notification settings - Fork 854
docs: snippets should be outside of markdown #1715
Copy link
Copy link
Closed
Labels
area/documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Flagging this for post-europa.
CUE snippets used to be external to markdown files, like so:
```cue file=./tests/cloudformation/template.cue title="todoapp/cloudformation/template.cue"
``
This allows:
- CUE linter cleaning up the files / validating them
- Adding automated tests using the snippets, to make sure the docs work
I think I've seen a couple of embedded CUE snippets in the latest Europa markdowns (/cc @gerhard @helderco)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
area/documentationImprovements or additions to documentationImprovements or additions to documentation