haskell / haskell/cabal

Documentation shouldn't use Cabal packages as examples

Open
#5,158 8 comments 5 reactions 0 assignees View on GitHub
cabal-install: v2-build system documentation type: enhancement
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

You shouldn't use Cabal and cabal-install as examples in the cabal documentation. The reader has to mentally quote stuff to understand which level the text is talking about.

Contributor guide

Open the contributing guide

Research direction

Start by locating the Cabal and cabal-install examples throughout the documentation and read the surrounding sections to identify which concepts each example represents. Done means the examples clearly distinguish the relevant levels without requiring readers to mentally quote the names.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.