Skip to content

Conversation

christiaanb
Copy link
Member

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.

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/
Copy link
Member

@martijnbastiaan martijnbastiaan left a 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!

Copy link
Member

@DigitalBrains1 DigitalBrains1 left a 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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
Copy link
Member

@DigitalBrains1 DigitalBrains1 Oct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants