Create an Algebra microsite

typelevel / algebra

Experimental project to lay out basic algebra type classes

https://typelevel.org/algebra/

Other

378 stars 69 forks source link

Create an Algebra microsite #193

Closed sritchie closed 7 years ago

sritchie commented 7 years ago

This PR creates a microsite for Algebra. To that end it:

moves the tour of its algebraic structures out of the README and into the microsite
adds a CONTRIBUTING.md page
adds an empty CHANGELOG.md, which we should start using!
struts out the site without adding much structure or documentation. I'll need input from the committers on that.
publishes all scaladocs to /api under the microsite

sritchie commented 7 years ago

We'll also want to add the microsite URL to the github description.

codecov-io commented 7 years ago

Current coverage is 74.12% (diff: 100%)

Merging #193 into master will increase coverage by 0.13%

@@             master       #193   diff @@
==========================================
  Files            36         36          
  Lines           769        769          
  Methods         708        708          
  Messages          0          0          
  Branches         61         61          
==========================================
+ Hits            569        570     +1   
+ Misses          200        199     -1   
  Partials          0          0

Powered by Codecov. Last update 06f311f...20e0236

johnynek commented 7 years ago

👍 looks good to me at a quick glance. Any example of the microsite? Should we check out the branch and build it (also happy to iterate on the main site).

sritchie commented 7 years ago

Let me push the microsite example now, one sec

sritchie commented 7 years ago

Live at https://sritchie.github.io/algebra! I didn't push a version with these changes:

https://github.com/typelevel/algebra/pull/193/commits/20e02364900540205da260fedbc2f8e877e2ae86

So just note that quot and EuclideanRing are no longer mentioned.

sritchie commented 7 years ago

@tixxit @johnynek merge?