Release notes for 9.8 are poorly formatted
See https://ghc.gitlab.haskell.org/ghc/doc/users_guide/9.8.1-notes.html
It appears to me that many changes to those Notes were accepted without first rendering them to HTML. The issues include:
- Broken link formatting, e.g. the links to https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0540-jsem.rst and https://gitlab.haskell.org/ghc/ghc/-/wikis/building are not displayed correctly.
- Numerous cases of using single backticks (Markdown style) instead of double backticks (RST style), so the renderer uses italics instead of monospace. Examples: "INCOHERENT pragma", "the –enable-static-libzstd configure flag".
- Utterly broken code snippet in the
WARNING "do not use that constructor"
example. - The paragraph that starts "Record fields now belong to separate" is then almost entirely monospace.
- The "Included libraries" subheading uses the wrong level, it shouldn't be a subsection of "
template-haskell
library".
In addition to that, ticket references start with %s
instead of #
, e.g. %s22448
instead of #22448
. This is probably not specific to release notes, as the markup used there seems quite reasonable to me.
See :ghc-ticket:`22448` for further details.