haskell / haskell/containers

Consider moving the tutorial off Read the Docs

Open
#1,100 0 comments 0 reactions 0 assignees View on GitHub
discussion/rfc docs
Dominant language
Haskell
Stars
355
Forks
194
Avg merge
3d 4h
Merged PRs (30d)
4

Description

RTD broke recently (#1090), which makes me think that we should consider more manageable alternatives (https://github.com/haskell/containers/issues/1090#issuecomment-2587281333).

> * Plain markdown files in this repo
> * The GitHub wiki feature (https://github.com/haskell/containers/wiki)
> * A tutorial module (e.g. [Pipes.Tutorial](https://hackage.haskell.org/package/pipes-4.3.16/docs/Pipes-Tutorial.html)).

Opinions welcome.

Personally I like the idea of a Tutorial module. It's the option with the best visibility and links to functions and types work without any extra effort.

Related: This ongoing discussion on Discourse https://discourse.haskell.org/t/library-companion-site-tools/11276

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.