Skip to content

Conversation

martijnbastiaan
Copy link
Member

@martijnbastiaan martijnbastiaan commented Aug 18, 2025

Our current documentation's Javascript on Hackage is broken, making it hard to navigate. This has been solved in newer GHCs.

Fixes #2981


We shouldn't merge the backport of this PR, before we've seen a nightly run publish to Hackage and checking the documentation for obvious flaws.

Still TODO:

  • Write a changelog entry (see changelog/README.md)
  • Check copyright notices are up to date in edited files

@DigitalBrains1
Copy link
Member

Leon and I spent some brain cycles on this as well.

It's probably better to use GHC 9.6 until GHC MR 14447 has made it to a version of GHC we support in Clash. Because I think our CI job is going to really balk at all the link destination warnings.

Leon and I were also discussing ways to diff the before and after of our Haddock, and reducing that diff to something a human can grok, to check if stuff broke. Because I'm worried updating to a newer Haddock will break stuff, either because we did something wrong that caused no issue before but now does, or because Haddock changed something in a way that doesn't work how we use it (like the Cabal upgrade did recently).

@martijnbastiaan
Copy link
Member Author

Alright, I'll change it to 9.6. I'll report an issue so we don't forget to diff. I do think moving forward on this (even if it breaks some other things) is the way to go, because of how massively broken the status quo is.

Our current documentation's Javascript on Hackage is broken, making it
hard to navigate. This has been solved in newer GHCs.

Fixes #2981
@martijnbastiaan martijnbastiaan changed the title Bump Haddock GHC to 9.10.1 Bump Haddock GHC to 9.6.7 Sep 6, 2025
@martijnbastiaan martijnbastiaan merged commit af37307 into master Sep 6, 2025
14 checks passed
@martijnbastiaan martijnbastiaan deleted the bump-haddock-ghc branch September 6, 2025 14:58
@mergify mergify bot mentioned this pull request Sep 6, 2025
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Quick Jump feature broken on some of our hackage documentation
2 participants