Documentation Updates

gitbook/SUMMARY.md

@@ -2,147 +2,272 @@
 
 * FsToolkit.ErrorHandling
   * Result
-    * [map2](result/map2.md)
-    * [map3](result/map3.md)
     * [apply](result/apply.md)
+    * [bind](result/bind.md)
+    * [Computation Expression](result/ce.md)
+    * [either Functions](result/eitherFunctions.md)
     * [fold](result/fold.md)
-    * [ofChoice](result/ofChoice.md)
     * [ignore](result/ignore.md)
-    * [Computation Expression](result/ce.md)
+    * [map](result/map.md)
+    * [map2](result/map2.md)
+    * [map3](result/map3.md)
+    * [mapError](result/mapError.md)
+    * [ofChoice](result/ofChoice.md)
     * [Operators](result/operators.md)
+    * [orElse Functions](result/orElseFunctions.md)
     * [Other Functions](result/others.md)
+    * [require Functions](result/requireFunctions.md)
+    * [tee Functions](result/teeFunctions.md)
+    * [tryCreate](result/tryCreate.md)
+    * [zip](result/zip.md)
+    * [zipError](result/zipError.md)
     * Lists
       * [traverseResultM](list/traverseResultM.md)
       * [sequenceResultM](list/sequenceResultM.md)
       * [traverseResultA](list/traverseResultA.md)
       * [sequenceResultA](list/sequenceResultA.md)
 
   * Option
-    * [traverseResult](option/traverseResult.md)
-    * [sequenceResult](option/sequenceResult.md)
+    * [bind](pr.md)
+    * [bindNull](pr.md)
     * [Computation Expression](option/ce.md)
+    * [either](pr.md)
+    * [map](pr.md)
+    * [ofPair](pr.md)
+    * [ofValueOption](pr.md)
+    * [toValueOption](pr.md)
+    * [zip](pr.md)
+    * Lists
+      * [traverseResult](option/traverseResult.md)
+      * [sequenceResult](option/sequenceResult.md)
 
   * ResultOption
-    * [map](resultOption/map.md)
-    * [map2](resultOption/map2.md)
-    * [map3](resultOption/map3.md)
     * [apply](resultOption/apply.md)
     * [bind](resultOption/bind.md)
-    * [ignore](resultOption/ignore.md)
     * [Computation Expression](resultOption/ce.md)
+    * [ignore](resultOption/ignore.md)
+    * [map](resultOption/map.md)
+    * [map2](resultOption/map2.md)
+    * [map3](resultOption/map3.md)
+    * [mapError](pr.md)
+    * [ofResult](pr.md)
+    * [ofOption](pr.md)
+    * [ofChoice](pr.md)
     * [Operators](resultOption/operators.md)
+    * [zip](resultOption/zip.md)
+    * [zipError](resultOption/zipError.md)
 
   * AsyncResult
+    * [apply](asyncResult/apply.md)
+    * [bind](asyncResult/bind.md)
+    * [Computation Expression](asyncResult/ce.md)
+    * [error](pr.md)
+    * [foldResult](asyncResult/foldResult.md)
+    * [ignore](asyncResult/ignore.md)
     * [map](asyncResult/map.md)
     * [map2](asyncResult/map2.md)
     * [map3](asyncResult/map3.md)
     * [mapError](asyncResult/mapError.md)
-    * [apply](asyncResult/apply.md)
-    * [foldResult](asyncResult/foldResult.md)
+    * [ofAsync](pr.md)
+    * [ofResult](pr.md)
     * [ofTask](asyncResult/ofTask.md)
     * [ofTaskAction](asyncResult/ofTaskAction.md)
-    * [bind](asyncResult/bind.md)
-    * [ignore](asyncResult/ignore.md)
-    * [Computation Expression](asyncResult/ce.md)
     * [Operators](asyncResult/operators.md)
     * [Other Functions](asyncResult/others.md)
+    * [zip](pr.md)
+    * [zipError](pr.md)
     * List
       * [traverseAsyncResultM](list/traverseAsyncResultM.md)
       * [sequenceAsyncResultM](list/sequenceAsyncResultM.md)
       * [traverseAsyncResultA](list/traverseAsyncResultA.md)
       * [sequenceAsyncResultA](list/sequenceAsyncResultA.md)
 
   * AsyncResultOption
-    * [map](asyncResultOption/map.md)
-    * [map2](asyncResultOption/map2.md)
-    * [map3](asyncResultOption/map3.md)
     * [apply](asyncResultOption/apply.md)
     * [bind](asyncResultOption/bind.md)
-    * [ignore](asyncResultOption/ignore.md)
     * [Computation Expression](asyncResultOption/ce.md)
+    * [ignore](asyncResultOption/ignore.md)
+    * [map](asyncResultOption/map.md)
+    * [map2](asyncResultOption/map2.md)
+    * [map3](asyncResultOption/map3.md)
+    * [ofAsyncOption](pr.md)
+    * [ofAsyncResult](pr.md)
+    * [ofOption](pr.md)
+    * [ofResult](pr.md)
     * [Operators](asyncResultOption/operators.md)
 
   * [Validation](validation/index.md)
+    * [apply](validation/apply.md)
+    * [Computation Expression](validation/ce.md)
+    * [error](pr.md)
+    * [map](pr.md)
     * [map2](validation/map2.md)
     * [map3](validation/map3.md)
-    * [apply](validation/apply.md)
+    * [mapError](pr.md)
+    * [mapErrors](pr.md)
+    * [ofChoice](pr.md)
     * [ofResult](validation/ofResult.md)
     * [Operators](validation/operators.md)
-    * [Result.tryCreate](validation/tryCreate.md)
-    * [Computation Expression](validation/ce.md)
+    * [returnError](pr.md)
+    * [zip](pr.md)
 
   * [AsyncValidation](asyncValidation/index.md)
+    * [apply](asyncValidation/apply.md)
+    * [Computation Expression](asyncValidation/ce.md)
+    * [error](pr.md)
+    * [map](pr.md)
     * [map2](asyncValidation/map2.md)
     * [map3](asyncValidation/map3.md)
-    * [apply](asyncValidation/apply.md)
+    * [mapError](pr.md)
+    * [mapErrors](pr.md)
+    * [ofChoice](pr.md)
     * [ofResult](asyncValidation/ofResult.md)
     * [Operators](asyncValidation/operators.md)
-    * [Computation Expression](asyncValidation/ce.md)
+    * [returnError](pr.md)
+    * [zip](pr.md)
 
 * FsToolkit.ErrorHandling.AsyncSeq
+  * AsyncSeq
+    * [Computation Expression](pr.md)
+
 * FsToolkit.ErrorHandling.IcedTasks
   * [CancellableTaskResult](cancellableTaskResult/index.md)
-    * [map](cancellableTaskResult/map.md)
-    * [map2](cancellableTaskResult/map2.md)
-    * [map3](cancellableTaskResult/map3.md)
-    * [mapError](cancellableTaskResult/mapError.md)
     * [apply](cancellableTaskResult/apply.md)
-    * [foldResult](cancellableTaskResult/foldResult.md)
-    * [ofAsync](cancellableTaskResult/ofAsync.md)
     * [bind](cancellableTaskResult/bind.md)
-    * [ignore](cancellableTaskResult/ignore.md)
     * [Computation Expression](cancellableTaskResult/ce.md)
+    * [getCancellationToken](pr.md)
+    * [map](cancellableTaskResult/map.md)
     * [Operators](cancellableTaskResult/operators.md)
     * [Other Functions](cancellableTaskResult/others.md)
+    * [zip](pr.md)
+    * [parallelZip](pr.md)
+
   * [CancellableTaskValidation](cancellableTaskValidation/index.md)
-    * [map2](cancellableTaskValidation/map2.md)
-    * [map3](cancellableTaskValidation/map3.md)
     * [apply](cancellableTaskValidation/apply.md)
+    * [bind](pr.md)
     * [Computation Expression](cancellableTaskValidation/ce.md)
+    * [error](pr.md)
+    * [getCancellationToken](pr.md)
+    * [map](pr.md)
+    * [map2](cancellableTaskValidation/map2.md)
+    * [map3](cancellableTaskValidation/map3.md)
+    * [mapError](pr.md)
+    * [mapErrors](pr.md)
+    * [ofChoice](pr.md)
+    * [ofResult](pr.md)
     * [Operators](cancellableTaskValidation/operators.md)
+    * [zip](pr.md)
+    * [parallelZip](pr.md)
+
 * FsToolkit.ErrorHandling.JobResult
+  * Job
+    * [apply](pr.md)
+    * [map2](pr.md)
+    * [map3](pr.md)
+    * [singleton](pr.md)
+    * [zip](pr.md)
+
+  * JobOption
+    * [apply](pr.md)
+    * [bind](pr.md)
+    * [ce](jobOption/ce.md)
+    * [either](pr.md)
+    * [map](pr.md)
+
   * JobResult
+    * [apply](jobResult/apply.md)
+    * [bind](jobResult/bind.md)
+    * [catch](pr.md)
+    * [Computation Expression](jobResult/ce.md)
+    * [error](pr.md)
+    * [fromTask](pr.md)
+    * [fromUnitTask](pr.md)
+    * [ignore](jobResult/ignore.md)
     * [map](jobResult/map.md)
     * [map2](jobResult/map2.md)
     * [map3](jobResult/map3.md)
     * [mapError](jobResult/mapError.md)
-    * [apply](jobResult/apply.md)
-    * [foldResult](jobResult/foldResult.md)
+    * [ofAsync](pr.md)
+    * [ofJob](pr.md)
+    * [ofResult](pr.md)
     * [ofTask](jobResult/ofTask.md)
-    * [bind](jobResult/bind.md)
-    * [ignore](jobResult/ignore.md)
-    * [Computation Expression](jobResult/ce.md)
     * [Operators](jobResult/operators.md)
     * [Other Functions](jobResult/others.md)
+    * [returnError](pr.md)
+    * [zip](pr.md)
+    * [zipError](pr.md)
+    * Lists
+      * [traverseJobResultM](pr.md)
+      * [sequenceJobResultM](pr.md)
+      * [traverseJobResultA](pr.md)
+      * [sequenceJobResultA](pr.md)
+
+  * JobResultOption
+    * [apply](pr.md)
+    * [bind](pr.md)
+    * [Computation Expression](pr.md)
+    * [ignore](pr.md)
+    * [map](pr.md)
+    * [map2](pr.md)
+    * [map3](pr.md)
+
 * FsToolkit.ErrorHandling.TaskResult
+  * Task
+    * [apply](pr.md)
+    * [bind](pr.md)
+    * [bindV](pr.md)
+    * [catch](pr.md)
+    * [Computation Expression](pr.md)
+    * [ignore](pr.md)
+    * [map](pr.md)
+    * [mapV](pr.md)
+    * [map2](pr.md)
+    * [map3](pr.md)
+    * [ofUnit](pr.md)
+    * [zip](pr.md)
+
+  * TaskOption
+    * [apply](pr.md)
+    * [bind](pr.md)
+    * [Computation Expression](taskOption/ce.md)
+    * [either](pr.md)
+    * [map](pr.md)
+    * [some](pr.md)
+    * [zip](pr.md)
+
   * TaskResult
+    * [apply](taskResult/apply.md)
+    * [bind](taskResult/bind.md)
+    * [catch](pr.md)
+    * [Computation Expression](taskResult/ce.md)
+    * [ignore](taskResult/ignore.md)
     * [map](taskResult/map.md)
     * [map2](taskResult/map2.md)
     * [map3](taskResult/map3.md)
     * [mapError](taskResult/mapError.md)
-    * [apply](taskResult/apply.md)
-    * [foldResult](taskResult/foldResult.md)
-    * [ofAsync](taskResult/ofAsync.md)
-    * [bind](taskResult/bind.md)
-    * [ignore](taskResult/ignore.md)
-    * [Computation Expression](taskResult/ce.md)
+    * [ofAsync](pr.md)
+    * [ofResult](pr.md)
+    * [ofTask](pr.md)
     * [Operators](taskResult/operators.md)
     * [Other Functions](taskResult/others.md)
+    * [returnError](pr.md)
+    * [zip](pr.md)
+    * [zipError](pr.md)
     * Lists
       * [traverseTaskResultM](list/traverseTaskResultM.md)
       * [sequenceTaskResultM](list/sequenceTaskResultM.md)
       * [traverseTaskResultA](list/traverseTaskResultA.md)
       * [sequenceTaskResultA](list/sequenceTaskResultA.md)
+
   * TaskResultOption
-    * [map](taskResultOption/map.md)
-    * [map2](taskResultOption/map2.md)
-    * [map3](taskResultOption/map3.md)
     * [apply](taskResultOption/apply.md)
     * [bind](taskResultOption/bind.md)
-    * [ignore](taskResultOption/ignore.md)
     * [Computation Expression](taskResultOption/ce.md)
+    * [ignore](taskResultOption/ignore.md)
+    * [map](taskResultOption/map.md)
+    * [map2](taskResultOption/map2.md)
+    * [map3](taskResultOption/map3.md)
     * [Operators](taskResultOption/operators.md)
-  * TaskOption
-    * [Computation Expression](taskOption/ce.md)
+
 * General Docs
   * [Bind Mappings](bindMappings.md)

gitbook/asyncValidation/index.md

@@ -1,4 +1,4 @@
-## AsyncValidation
+# AsyncValidation
 
 Namespace: `FsToolkit.ErrorHandling`
 

gitbook/list/sequenceResultA.md

@@ -1,10 +1,10 @@
-## List.sequenceResultA
+# List.sequenceResultA
 
 Namespace: `FsToolkit.ErrorHandling`
 
-Function Signature:
+## Function Signature
 
-```
+```fsharp
 Result<'a, 'b> list -> Result<'a list, 'b list>
 ```
 

gitbook/list/sequenceResultM.md

@@ -1,10 +1,10 @@
-## List.sequenceResultM
+# List.sequenceResultM
 
 Namespace: `FsToolkit.ErrorHandling`
 
-Function Signature:
+## Function Signature
 
-```
+```fsharp
 Result<'a, 'b> list -> Result<'a list, 'b>
 ```
 

gitbook/list/traverseResultA.md

@@ -1,10 +1,10 @@
-## List.traverseResultA
+# List.traverseResultA
 
 Namespace: `FsToolkit.ErrorHandling`
 
-Function Signature:
+## Function Signature
 
-```
+```fsharp
 ('a -> Result<'b,'c>) -> 'a list -> Result<'b list, 'c list>
 ```
 

gitbook/list/traverseResultM.md

@@ -1,10 +1,10 @@
-## List.traverseResultM
+# List.traverseResultM
 
 Namespace: `FsToolkit.ErrorHandling`
 
-Function Signature:
+## Function Signature
 
-```
+```fsharp
 ('a -> Result<'b,'c>) -> 'a list -> Result<'b list, 'c>
 ```
 

gitbook/pr.md

@@ -0,0 +1,3 @@
+# Sorry, this page is not yet documented
+
+This feature is supported in the library, but we have not got to documenting it yet. Feel free to open an [issue or PR](https://github.com/demystifyfp/FsToolkit.ErrorHandling) to add documentation for this feature.