[Haddock] Release plans

Mark Lentczner markl at glyphic.com
Thu Aug 19 06:44:31 EDT 2010

On Aug 19, 2010, at 4:00 AM, David Waern wrote:

> So I was thinking we should try to get a new Haddock release out quite
> soon, so that it will get some testing before we ship it with the
> release of GHC 6.14.1. I will aim for the end of this month or the
> beginning of next.

Sounds fine to me. My timing is this: The last part of our vacation involves camping in a cabin for the next five days, starting today. I'm probably not going to get any Haddock work done during that. Then I'm back home, and have the week of Aug23 - 29 free. I start my new job on the 30th. Hence, I have about a week to wrap up my Haddock work.

> The release should contain:
> * The new XHTML backend and the new theme.

I think the new backend and theme is essentially done. My final "to do" list has:
	[] improve how the synopsis is hidden when in frames
	[] dang scrollbars in pre sections under some WebKit settings
	[] review the impact and implications of the anchor id format changes
	[] check new scheme for colorblind viewers
	[] check for any javascript errors
	[] check that classic theme is all good-to-go
	   (and hasn't fallen out of sync with markup)

plus whatever minor nits occur, like the two tibbe just found...

We should decide if we are going to include the Snappy theme, and if so, give it some lovin', as it is a bit out of date with the current markup. An issue is that it uses web fonts and the .css points at the Snap project's web server for them.

Similarly, we'll have to give guidance to both the GHC and Hackage teams for what we think they should do: Specifically if they should produce doc in just the new theme, or with "--default-themes" enabled. Also, I'm still working on a "rebuild all my doc on my machine" script - and may have that done in time. Similarly, we'll want to confer with Hackage team on if they should consider rebuilding the doc for all "tip" packages.

> So I'm assuming that we will be ready to ship the new theme as default
> with GHC 6.14.1. Do you guys agree with that?

Yes! I'm excited to put a bow on it and call it done!

	- Mark

More information about the Haddock mailing list