-
Notifications
You must be signed in to change notification settings - Fork 164
Move content from the Clash.Tutorial
module to docs.clash-lang.org
#3019
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
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/
921b548
to
920bc99
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This LGTM. Fighting Haddock wasn't fun anyway!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's one "in at". If we're going to tackle that one anyway, let's also change some "in"s to "at"s.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A preliminary version of a tutorial can be found in at | |
A preliminary version of a tutorial can be found at |
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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".
The content from the
Clash.Tutorial
module 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-prelude
package for the publication of this content.