Skip to content

Bring the Haskell documentation back into nixpkgs #121403

@maralorn

Description

@maralorn

Suggestion

This is a suggestion to move the documentation for haskellPackages back into the nixpkgs manual. It is currently maintained in the cabal2nix repo and hosted at https://haskell4nix.readthedocs.io

Pros:

  • Unified design and single entry point for users
  • Easier to edit and discover
  • Documentation and changes to nixpkgs can be done in the same commit/PR.
  • No one needs to maintain the extra page.

Cons:

  • (Small) parts of it need to be translated to md.
  • Right now the nixpkgs manual has a much worse table of content and we don‘t get anchor-links for 4th level headings.

Alternatives:

  • Never do this
  • Do this only when the nixpkgs manual has been switched to mdbook, which is apparently going to happen.

I am mentioning this because I‘d like our new workflows and scripts to be documented asap.

What do you think @NixOS/haskell?

Metadata

Metadata

Assignees

No one assigned

    Labels

    6.topic: documentationMeta-discussion about documentation and its workflow6.topic: haskellGeneral-purpose, statically typed, purely functional programming language
    No fields configured for issues without a type.

    Projects

    Status

    ⚠ Blocked

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions