clash-lang / clash-lang/clash-protocols

Check dead doc links / API parity on CI

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

Description

* This project's CI enforces a 100% documentation coverage for the library to be published on Hackage. Perhaps we could use something like https://pypi.org/project/deadlinks/ to enforce non-broken links too.
* It would be nice to enforce API parity between `Protocols.Df` and `Protocols.Df.Simple` (where possible).

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the repository's existing CI configuration and documentation coverage checks, then inspect the Protocols.Df and Protocols.Df.Simple APIs. Determine how dead documentation links and possible API mismatches can be checked in CI; done means both checks run automatically and fail for detected problems.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
ci-cd, documentation, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.