More on docs

codedownio · Feb 4, 2025 · 39c6eea · 39c6eea
1 parent 4fb96cf
commit 39c6eea
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 1 deletion.
diff --git a/sandwich-site/docs/context-libraries/sandwich-contexts-minio.md b/sandwich-site/docs/context-libraries/sandwich-contexts-minio.md
@@ -2,3 +2,29 @@
 id: sandwich-contexts-minio
 title: MinIO
 ---
+
+The [Test.Sandwich.Contexts.MinIO](https://hackage.haskell.org/package/sandwich-contexts-minio/docs/Test-Sandwich-Contexts-MinIO.html) module provides the ability introduce MinIO S3 servers, either using a raw binary or a container system.
+
+This module is provided as part of the [sandwich-contexts-minio](https://hackage.haskell.org/package/sandwich-contexts-minio) package.
+
+## Via Nix-provided binary
+
+```haskell title="https://github.com/codedownio/sandwich/blob/master/demos/demo-minio/app/Main.hs"
+spec :: TopSpec
+spec = describe "Introducing MinIO" $ do
+  introduceNixContext nixpkgsReleaseDefault $ introduceMinIOViaNix defaultMinIOContextOptions $ do
+    it "prints the MinIO server info" $ do
+      server <- getContext testS3Server
+      info [i|Got S3 server: #{server}|]
+```
+
+## Via container
+
+```haskell title="https://github.com/codedownio/sandwich/blob/master/demos/demo-minio/app/Main.hs"
+spec :: TopSpec
+spec = describe "Introducing MinIO" $ do
+  introduceMinIOViaContainer defaultMinIOContextOptions defaultContainerOptions $ do
+    it "prints the MinIO server info" $ do
+      server <- getContext testS3Server
+      info [i|Got S3 server: #{server}|]
+```
diff --git a/sandwich-webdriver/src/Test/Sandwich/WebDriver/Types.hs b/sandwich-webdriver/src/Test/Sandwich/WebDriver/Types.hs
@@ -6,7 +6,7 @@
 {-# OPTIONS_GHC -fno-warn-orphans #-}
 
 module Test.Sandwich.WebDriver.Types (
-  -- * Type aliases to make signatures shorter
+  -- * Type aliases to make signatures shorter.
   BaseMonad
   , ContextWithWebdriverDeps
   , ContextWithBaseDeps