Remove content from Clash.Tutorial module

The actual tutorial has been moved to:
https://docs.clash-lang.org/tutorial/

Parts that belong to the Clash compiler user guide have
been moved to:
https://docs.clash-lang.org/compiler-user-guide/

Author: christiaanb

changelog/2025-09-26T14_06_42+02_00_move_tutorial

@@ -0,0 +1,5 @@
+CHANGED: The content from the `Clash.Tutorial` module has been split and moved to two new locations.
+1. The actual tutorial parts has been moved to: https://docs.clash-lang.org/tutorial/
+2. Parts that fit better in the clash compiler user guide have been moved to: https://docs.clash-lang.org/compiler-user-guide/
+
+Moving the documentation to these locations makes it easier to update their content as it is no longer needed to release a new version of the `clash-prelude` package for the publication of this content.

clash-prelude/clash-prelude.cabal

@@ -39,9 +39,10 @@ Description:
     "Clash.Prelude" and "Clash.Explicit.Prelude" at the same time as they
     have overlapping definitions.
   .
-  A preliminary version of a tutorial can be found in "Clash.Tutorial", for a
-  general overview of the library you should however check out "Clash.Prelude".
-  Some circuit examples can be found in "Clash.Examples".
+  A preliminary version of a tutorial can be found at
+  <https://docs.clash-lang.org/tutorial>, for a general overview of the library
+  you should however check out "Clash.Prelude". Some circuit examples can be
+  found in "Clash.Examples".
 Homepage:             https://clash-lang.org/
 bug-reports:          https://github.com/clash-lang/clash-compiler/issues
 License:              BSD-2-Clause

clash-prelude/src/Clash/Explicit/Synchronizer.hs

@@ -193,7 +193,6 @@ isFull addrSize@SNat ptr s_ptr =
       in  ptr == (complement (slice addrSize a1 s_ptr) ++# slice a2 d0 s_ptr)
 
 -- | Synchronizer implemented as a FIFO around a synchronous RAM. Based on the
--- design described in "Clash.Tutorial#multiclock", which is itself based on the
 -- design described in <http://www.sunburst-design.com/papers/CummingsSNUG2002SJ_FIFO1.pdf>.
 -- However, this FIFO uses a synchronous dual-ported RAM which, unlike those
 -- designs using RAM with an asynchronous read port, is nearly guaranteed to

clash-prelude/src/Clash/Prelude.hs

@@ -29,8 +29,9 @@
     have overlapping definitions.
 
   For now, "Clash.Prelude" is also the best starting point for exploring the
-  library. A preliminary version of a tutorial can be found in "Clash.Tutorial".
-  Some circuit examples can be found in "Clash.Examples".
+  library. A preliminary version of a tutorial can be found at
+  https://docs.clash-lang.org/tutorial. Some circuit examples can be found in
+  "Clash.Examples".
 -}
 
 {-# LANGUAGE CPP #-}

clash-prelude/src/Clash/Prelude/Safe.hs

@@ -26,8 +26,9 @@
     explicitly clocked circuits in a multi-clock setting
 
   For now, "Clash.Prelude" is also the best starting point for exploring the
-  library. A preliminary version of a tutorial can be found in "Clash.Tutorial".
-  Some circuit examples can be found in "Clash.Examples".
+  library. A preliminary version of a tutorial can be found at
+  https://docs.clash-lang.org/tutorial. Some circuit examples can be found in
+  "Clash.Examples".
 -}
 
 {-# LANGUAGE CPP #-}