cullophid / date-fp

Functional programming date manipulation library
121 stars 17 forks source link

Gitbook Docs #25

Closed cullophid closed 8 years ago

cullophid commented 8 years ago

I have moved our docs to a gitbook

This makes them easier to read, and allows users to search for at function.

svozza commented 8 years ago

Nice. I think it would look nicer if the heading names in the left-hand column were just the name of the function and the proper Haskell notation was the heading on the actual page with the info. Several of the type sigs are truncated as it is so it makes more sense to have them in the place with more screen real estate.

cullophid commented 8 years ago

I have added the changes from https://github.com/cullophid/date-fp/pull/24

cullophid commented 8 years ago

@svozza I agree I have removed the type sig from the summary, and moved it to functions headers

svozza commented 8 years ago

Looks great and a definite improvement on my PR, we get nice links and informative type sigs with no losses.

svozza commented 8 years ago

Do you need to add gitbooks to the devDependencies?

cullophid commented 8 years ago

@svozza yes the gitbook get build as part of the deploy step