Add documentation Manual.md and DesignPrinciples.md (#5044)

* Added sub directory src/Constrained/Min  where we keep a minimal version of the system.
The idea is that is easier to explain, since it doesn't have things like Generics.
It consists of Constrained.Min.Base.hs, Constraied.Min.Syntax.hs, Constrained.Min.Model.hs,
and Constrained.Min.Tuple.hs
Added the file docs/constrained/DesignPrinciples.md that describes this minimal system.

* Describe computeSpecSimplified, the  use of SolverPlan and propagageSpec.

* parent 90eeb3a
author Tim Sheard <sheard@pdx.edu> 1747246081 -0700
committer Tim Sheard <sheard@pdx.edu> 1750253688 -0400

Added a second document docs/constrained_generators/manual.md
This is a basic manual about how to write constraints, but does not
go into details about how the system is implemented.

Author: TimSheard

docs/constrained-generators/DesignPrinciples.md

@@ -1,4 +1,5 @@
 {-# LANGUAGE AllowAmbiguousTypes #-}
+{-# LANGUAGE LambdaCase #-}
 {-# LANGUAGE NamedFieldPuns #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 

docs/constrained-generators/manual.md

@@ -306,6 +306,9 @@ cradle:
     - path: "libs/constrained-generators/src"
       component: "lib:constrained-generators"
 
+    - path: "libs/constrained-generators/testlib"
+      component: "constrained-generators:lib:testlib"
+
     - path: "libs/constrained-generators/test"
       component: "constrained-generators:test:constrained"
 

eras/conway/impl/testlib/Test/Cardano/Ledger/Conway/Proposals.hs

@@ -31,6 +31,7 @@ library
     Constrained.Examples.Either
     Constrained.Examples.Fold
     Constrained.Examples.List
+    Constrained.Examples.ManualExamples
     Constrained.Examples.Map
     Constrained.Examples.Set
     Constrained.Examples.Tree
@@ -74,6 +75,32 @@ library
     random,
     template-haskell,
 
+library testlib
+  exposed-modules:
+    Test.Minimal.Base
+    Test.Minimal.Model
+    Test.Minimal.Syntax
+    Test.Minimal.Tuple
+
+  hs-source-dirs: testlib
+  default-language: Haskell2010
+  ghc-options:
+    -Wall
+    -Wcompat
+    -Wincomplete-record-updates
+    -Wincomplete-uni-patterns
+    -Wpartial-fields
+    -Wredundant-constraints
+    -Wunused-packages
+
+  build-depends:
+    QuickCheck >=2.14,
+    base >=4.18 && <5,
+    constrained-generators,
+    containers,
+    mtl,
+    prettyprinter,
+
 test-suite constrained
   type: exitcode-stdio-1.0
   main-is: Tests.hs
@@ -105,12 +132,6 @@ benchmark bench
   default-language: Haskell2010
   ghc-options:
     -Wall
-    -Wcompat
-    -Wincomplete-record-updates
-    -Wincomplete-uni-patterns
-    -Wpartial-fields
-    -Wredundant-constraints
-    -Wunused-packages
     -rtsopts
 
   build-depends: