IntersectMBO / IntersectMBO/cardano-transactions

Haddock documentation not yet viewable on Hackage.

Open
#11 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Haskell
Stars
25
Forks
7
PR merge metrics
No merged PRs in 30d

Description

### Reproduction Steps

- View the `cardano-transactions` library on [Hackage](https://hackage.org/):
https://hackage.haskell.org/package/cardano-transactions
- Navigate to the **"Modules"** section header.
- Attempt to view the documentation for a module within the package.
_For example:_ `Data.UTxO.Transaction`.

### Expected Behaviour

- Each module name is a link that, when followed, leads to the documentation for that module. :link:

### Actual Behaviour

- The module names do not link to documentation.

### Possible Causes

Hackage appears to be unable to build the package:
https://hackage.haskell.org/package/cardano-transactions-1.0.0/reports/

(Presumably because of other library dependencies from the Cardano ecosystem that are not yet on Hackage.)

### Relevance

Being able to view the documentation on Hackage would be useful, since:

- the version of the documentation linked to in the README corresponds to the latest commit to `master`.
- users of the library may want to refer to older versions of the documentation (not yet relevant, but will become so if/when new versions are released).

Contributor guide

Open the contributing guide

Research direction

Start with the Hackage build report for cardano-transactions-1.0.0 and compare it with the package configuration and dependencies referenced by the repository. Check the README's documentation link and the Data.UTxO.Transaction module on Hackage; done means Hackage successfully builds the package and module names link to their documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
build-system, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.