haskell / haskell/cabal

Documentation: v1 to v2 migration guide.

Open
#6,104 8 comments 3 reactions 0 assignees View on GitHub
documentation re: v1-vs-v2 status: consider closing type: enhancement
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

cabal-install-3.0 changelog / release notes should point out to that part of documentation as the first things.

There will be a lot of confusion when 3.0 is released, and there are no migration guide explaining how `v2-build` or `v2-install` are different from `v1-build` or `v1-install`. The QuickStart section is not the right one, as it *doesn't explain the differences*.

Contributor guide

Open the contributing guide

Research direction

Locate the cabal-install-3.0 changelog or release notes and the QuickStart section mentioned in the issue. Read the existing documentation for v1-build, v1-install, v2-build, and v2-install, then add or identify a migration guide that explains their differences and link to it from the release notes.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
cli, 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.