Move content from the Clash.Tutorial module to docs.clash-lang.org
#3019
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/
christiaanb
force-pushed
the
remove_tutorial
branch
from
921b548 to
920bc99
Compare
martijnbastiaan
approved these changes
Oct 15, 2025
DigitalBrains1
requested changes
Oct 15, 2025
| 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 in |
There was a problem hiding this comment.
Suggested change
| library. A preliminary version of a tutorial can be found in | |
| library. A preliminary version of a tutorial can be found at |
| 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 in |
There was a problem hiding this comment.
Suggested change
| library. A preliminary version of a tutorial can be found in | |
| library. A preliminary version of a tutorial can be found at |
| 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 in at |
There was a problem hiding this comment.
Suggested change
| A preliminary version of a tutorial can be found in at | |
| A preliminary version of a tutorial can be found at |
DigitalBrains1
requested changes
Oct 16, 2025
| 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 in at | ||
| https://docs.clash-lang.org/tutorial, for a general overview of the library |
There was a problem hiding this comment.
Suggested change
| https://docs.clash-lang.org/tutorial, for a general overview of the library | |
| <https://docs.clash-lang.org/tutorial>, for a general overview of the library |
Oh, well that's fun! Even though this .cabal field uses Haddock markup, it doesn't seem to render plain links. It rendered as
A preliminary version of a tutorial can be found in at https:/docs.clash-lang.orgtutorial, for a general [...]
Another one in the book for "always check the result of your Haddock markup".
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The content from the
Clash.Tutorialmodule has been split and moved to two new locations.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-preludepackage for the publication of this content.