Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,26 @@ settings are:
There are also files in the `history/` subdirectory which contain history files used during run. See the
"History Checking" and "Generating History" sections for more info.

### Writing snippets for documentation

The repo can also be used as a way to author buildable/testable example snippets for our documentation. This is done
using Snipsync as described in the
[documentation repo](https://github.com/temporalio/documentation/blob/main/CONTRIBUTING.md#snipsync).

Snippets may be sourced from normal features, or, if writen purely for usage as a docs snippet they should be placed
in `features/snippets/snippet_name`. Beyond the path prefix, the folder contents should follow the same practices
as for a normal feature.

To define a snippet, use syntax like the following, where hellouniverse is the snippet identifier.

```
// @@@SNIPSTART hellouniverse
func HelloUniverse() {
fmt.Println("Hello Universe!")
}
// @@@SNIPEND
```

### Best Practices

- Try to only demonstrate/test one feature per feature directory.
Expand Down
Loading