Shimmur / checker_cab

an extraction of assert_values_for
MIT License
23 stars 4 forks source link

Set README.md as content for hex_doc index #41

Closed idlehands closed 8 months ago

idlehands commented 8 months ago

What does this do on a high level?

This updates the docs config so that when navigating to hexdocs.pm/checker_cab the contents of the README will be presented first.

How was this change made?

Added docs config into mix.exs

Why is this change necessary?

I received feedback that it was confusing to navigate the docs on hexdocs.pm

How will this be verified?

Any additional information or special handling required on this PR?

motivational imagery Homer Simpson reading book and not understanding anything

coveralls-official[bot] commented 8 months ago

Pull Request Test Coverage Report for Build 71ae2031e9bc1e5b4c45bb86527a9483f048cadd-PR-41

Details


Totals Coverage Status
Change from base Build 32f0a532b7241287509bf3c7d6f76268b767b1f7: 0.0%
Covered Lines: 43
Relevant Lines: 43

💛 - Coveralls