Merge pull request #295 from cschleiden/docs-slate

Add docs site

Author: cschleiden

.github/workflows/docs.yml

@@ -31,6 +31,10 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+      - name: build
+        run: |
+          sudo ./build.sh
+        working-directory: ./docs
       - name: Setup Pages
         uses: actions/configure-pages@v3
       - name: Upload artifact

client/client.go

@@ -23,7 +23,10 @@ import (
 	"go.opentelemetry.io/otel/trace"
 )
 
+// ErrWorkflowCanceled is returned when a workflow was already canceled.
 var ErrWorkflowCanceled = errors.New("workflow canceled")
+
+// ErrWorkflowTerminated is returned when a workflow was already terminated.
 var ErrWorkflowTerminated = errors.New("workflow terminated")
 
 type WorkflowInstanceOptions struct {
@@ -35,6 +38,7 @@ type Client struct {
 	clock   clock.Clock
 }
 
+// New creates a new client for the given backend.
 func New(backend backend.Backend) *Client {
 	return &Client{
 		backend: backend,

docs/README.md

@@ -0,0 +1,8 @@
+## Development
+
+1. Run
+```bash
+./serve.sh
+```
+
+2. Open http://localhost:4567/

docs/build.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+docker run --rm --name slate -p 4567:4567 \
+  -v "$(pwd)/source/logo.png":/srv/slate/source/images/logo.png \
+  -v "$(pwd)/source/index.html.md":/srv/slate/source/index.html.md \
+  -v "$(pwd)/source/includes":/srv/slate/source/includes \
+  -v "$(pwd)/build":/srv/slate/build slatedocs/slate build
+
+cp ./images/* ./build/images/