Skip to content

GitLab

  • Menu
Projects Groups Snippets
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in / Register
  • GHC GHC
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 4,867
    • Issues 4,867
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
  • Merge requests 457
    • Merge requests 457
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Deployments
    • Deployments
    • Releases
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Code review
    • Insights
    • Issue
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Glasgow Haskell Compiler
  • GHCGHC
  • Issues
  • #18853
Closed
Open
Created Oct 15, 2020 by Ben Gamari@bgamari🐢Maintainer

Consolidate developer documentation?

A recent discussion with @nh2 and @phadej reminded me of the rather fragmented state of our developer documentation. Currently GHC's developer documentation is spread across a number of places:

  • various namespaces of the ghc/ghc> wiki (e.g. Commentary, Working Conventions)
  • the users guide (e.g. "Care and feeding of the users guide")
  • various bits of in-tree documentation (e.g. hadrian/doc)

In particular while there is a great deal of prose on the Wiki, it has proven to be quite hard to keep up-to-date with on-going changes in the source tree. A few months ago we discussed the prospect of consolidating this documentation into a single developer guide (similar to the user guide). @simonpj and @rae both agreed that the idea sounded plausible. However, there are a few details to be worked out:

  • how do we avoid the MR workflow becoming an impediment to improving documentation?
  • how do we balance the desire to ensure the accuracy of the migrated content against the effort needed to do so?
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information
Assignee
Assign to
Time tracking