Skip to content

Conversation

@christiaanb
Copy link
Member

@christiaanb christiaanb commented Sep 26, 2025

The content from the Clash.Tutorial module and from https://clash-lang.readthedocs.io/ 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.

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.

christiaanb and others added 2 commits November 25, 2025 17:44
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/
And remove all the documentation that was there, including STYLE.rst and
HACKING.rst in the root.
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.

@christiaanb I cannot request your review on your own PR, but could you please indicate whether you are fine with the second commit?

@christiaanb
Copy link
Member Author

Yeah, I'm good

@christiaanb christiaanb merged commit 3bcc701 into master Nov 25, 2025
46 checks passed
@christiaanb christiaanb deleted the remove_tutorial branch November 25, 2025 17:47
@DigitalBrains1 DigitalBrains1 changed the title Move content from the Clash.Tutorial module to docs.clash-lang.org Move content from the Clash.Tutorial module and Read the Docs to docs.clash-lang.org Nov 26, 2025
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.

4 participants