wiki:WorkingConventions/DocumentationChanges

How to change GHC's documentation

Updating GHC's documentation is easy, and can benefit new comers greatly !

GHC's documentation is included within in its source code, using Haddock's markup.

Here are the steps to modify it:

  1. Create a Pull Request on GitHub.

  2. Wait for the reviewers to look at your patches. If this takes more than a week, complain!

  3. Wait for bgamari to publish the documentation. (As of Nov 2017, he runs the publish script manually, about once a month.) If this takes more than a month, complain on the #ghc channel on FreeNode !

Loathe github? You can update documentation using Phabricator too!

Then have a beer on us. We are truly grateful.

Last modified 16 months ago Last modified on Jul 14, 2018 7:37:15 PM