elm-review-documentation

Provides elm-review rules to help with the quality and correctness of your Elm project's documentation.

Provided rules

• Documentation.ReadmeLinksPointToCurrentVersion - Reports links in the README.md that do not point to the current version of the package.

Configuration

module ReviewConfig exposing (config)

import Review.Rule exposing (Rule)
import Documentation.ReadmeLinksPointToCurrentVersion

config : List Rule
config =
    [ Documentation.ReadmeLinksPointToCurrentVersion.rule
    ]

Try it out

You can try the example configuration above out by running the following command:

elm-review --template jfmengels/elm-review-documentation/example