Merge pull request #861 from vpavkin/fix-useful-links

Docs: Revive useful links section. Update URLs.
typelevel · Feb 4, 2016 · cf04445 · cf04445
2 parents 9961265 + 456ed11
commit cf04445
Show file tree

Hide file tree

Showing 32 changed files with 66 additions and 49 deletions.
diff --git a/core/src/main/scala/cats/FlatMap.scala b/core/src/main/scala/cats/FlatMap.scala
@@ -13,7 +13,7 @@ import simulacrum.typeclass
  *  but we can't implement pure (because we wouldn't know what key to use
  *  when instantiating the new Map).
  *
- *  @see See [[https://github.com/non/cats/issues/3]] for some discussion.
+ *  @see See [[https://github.com/typelevel/cats/issues/3]] for some discussion.
  *
  * Must obey the laws defined in cats.laws.FlatMapLaws.
  */

diff --git a/docs/src/main/tut/applicative.md b/docs/src/main/tut/applicative.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "Applicative"
 section: "typeclasses"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/Applicative.scala"
+source: "core/src/main/scala/cats/Applicative.scala"
 scaladoc: "#cats.Applicative"
 ---
 # Applicative

diff --git a/docs/src/main/tut/apply.md b/docs/src/main/tut/apply.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "Apply"
 section: "typeclasses"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/Apply.scala"
+source: "core/src/main/scala/cats/Apply.scala"
 scaladoc: "#cats.Apply"
 ---
 # Apply

diff --git a/docs/src/main/tut/const.md b/docs/src/main/tut/const.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "Const"
 section: "data"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/data/Const.scala"
+source: "core/src/main/scala/cats/data/Const.scala"
 scaladoc: "#cats.data.Const"
 ---
 # Const

diff --git a/docs/src/main/tut/contravariant.md b/docs/src/main/tut/contravariant.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "Contravariant"
 section: "typeclasses"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/functor/Contravariant.scala"
+source: "core/src/main/scala/cats/functor/Contravariant.scala"
 scaladoc: "#cats.functor.Contravariant"
 ---
 # Contravariant

diff --git a/docs/src/main/tut/foldable.md b/docs/src/main/tut/foldable.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "Foldable"
 section: "typeclasses"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/Foldable.scala"
+source: "core/src/main/scala/cats/Foldable.scala"
 scaladoc: "#cats.Foldable"
 ---
 # Foldable

diff --git a/docs/src/main/tut/freeapplicative.md b/docs/src/main/tut/freeapplicative.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "FreeApplicatives"
 section: "data"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/free/FreeApplicative.scala"
+source: "core/src/main/scala/cats/free/FreeApplicative.scala"
 scaladoc: "#cats.free.FreeApplicative"
 ---
 # Free Applicative

diff --git a/docs/src/main/tut/freemonad.md b/docs/src/main/tut/freemonad.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "FreeMonads"
 section: "data"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/free/Free.scala"
+source: "core/src/main/scala/cats/free/Free.scala"
 scaladoc: "#cats.free.Free"
 ---
 

diff --git a/docs/src/main/tut/functor.md b/docs/src/main/tut/functor.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "Functor"
 section: "typeclasses"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/Functor.scala"
+source: "core/src/main/scala/cats/Functor.scala"
 scaladoc: "#cats.Functor"
 ---
 # Functor

diff --git a/docs/src/main/tut/id.md b/docs/src/main/tut/id.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "Id"
 section: "typeclasses"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/package.scala"
+source: "core/src/main/scala/cats/package.scala"
 scaladoc: "#cats.Id$"
 ---
 # Id

diff --git a/docs/src/main/tut/invariant.md b/docs/src/main/tut/invariant.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "Invariant"
 section: "typeclasses"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/functor/Invariant.scala"
+source: "core/src/main/scala/cats/functor/Invariant.scala"
 scaladoc: "#cats.functor.Invariant"
 ---
 # Invariant

diff --git a/docs/src/main/tut/kleisli.md b/docs/src/main/tut/kleisli.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "Kleisli"
 section: "data"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/data/Kleisli.scala"
+source: "core/src/main/scala/cats/data/Kleisli.scala"
 scaladoc: "#cats.data.Kleisli"
 ---
 # Kleisli

diff --git a/docs/src/main/tut/monad.md b/docs/src/main/tut/monad.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "Monad"
 section: "typeclasses"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/Monad.scala"
+source: "core/src/main/scala/cats/Monad.scala"
 scaladoc: "#cats.Monad"
 ---
 # Monad

diff --git a/docs/src/main/tut/monadcombine.md b/docs/src/main/tut/monadcombine.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "MonadCombine"
 section: "typeclasses"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/MonadCombine.scala"
+source: "core/src/main/scala/cats/MonadCombine.scala"
 scaladoc: "#cats.MonadCombine"
 ---
 # MonadCombine

diff --git a/docs/src/main/tut/monadfilter.md b/docs/src/main/tut/monadfilter.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "MonadFilter"
 section: "typeclasses"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/MonadFilter.scala"
+source: "core/src/main/scala/cats/MonadFilter.scala"
 scaladoc: "#cats.MonadFilter"
 ---
 # MonadFilter

diff --git a/docs/src/main/tut/monoid.md b/docs/src/main/tut/monoid.md
@@ -88,6 +88,6 @@ N.B.
 Cats does not define a `Monoid` type class itself, it uses the [`Monoid`
 trait](https://github.com/non/algebra/blob/master/core/src/main/scala/algebra/Monoid.scala)
 which is defined in the [algebra project](https://github.com/non/algebra) on 
-which it depends. The [`cats` package object](https://github.com/non/cats/blob/master/core/src/main/scala/cats/package.scala)
+which it depends. The [`cats` package object](https://github.com/typelevel/cats/blob/master/core/src/main/scala/cats/package.scala)
 defines type aliases to the `Monoid` from algebra, so that you can
 `import cats.Monoid`.
diff --git a/docs/src/main/tut/monoidk.md b/docs/src/main/tut/monoidk.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "MonoidK"
 section: "typeclasses"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/MonoidK.scala"
+source: "core/src/main/scala/cats/MonoidK.scala"
 scaladoc: "#cats.MonoidK"
 ---
 # MonoidK

diff --git a/docs/src/main/tut/oneand.md b/docs/src/main/tut/oneand.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "OneAnd"
 section: "data"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/data/OneAnd.scala"
+source: "core/src/main/scala/cats/data/OneAnd.scala"
 scaladoc: "#cats.data.OneAnd"
 ---
 # OneAnd

diff --git a/docs/src/main/tut/optiont.md b/docs/src/main/tut/optiont.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "OptionT"
 section: "data"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/data/OptionT.scala"
+source: "core/src/main/scala/cats/data/OptionT.scala"
 scaladoc: "#cats.data.OptionT"
 ---
 # OptionT

diff --git a/docs/src/main/tut/semigroup.md b/docs/src/main/tut/semigroup.md
@@ -99,6 +99,6 @@ N.B.
 Cats does not define a `Semigroup` type class itself, it uses the [`Semigroup`
 trait](https://github.com/non/algebra/blob/master/core/src/main/scala/algebra/Semigroup.scala)
 which is defined in the [algebra project](https://github.com/non/algebra) on 
-which it depends. The [`cats` package object](https://github.com/non/cats/blob/master/core/src/main/scala/cats/package.scala)
+which it depends. The [`cats` package object](https://github.com/typelevel/cats/blob/master/core/src/main/scala/cats/package.scala)
 defines type aliases to the `Semigroup` from algebra, so that you can
-`import cats.Semigroup`.
+`import cats.Semigroup`.
diff --git a/docs/src/main/tut/semigroupk.md b/docs/src/main/tut/semigroupk.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "SemigroupK"
 section: "typeclasses"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/SemigroupK.scala"
+source: "core/src/main/scala/cats/SemigroupK.scala"
 scaladoc: "#cats.SemigroupK"
 ---
 # SemigroupK
@@ -30,7 +30,7 @@ Cats does not define a `Semigroup` type class itself. Instead, we use the
 trait](https://github.com/non/algebra/blob/master/core/src/main/scala/algebra/Semigroup.scala)
 which is defined in the [algebra
 project](https://github.com/non/algebra). The [`cats` package
-object](https://github.com/non/cats/blob/master/core/src/main/scala/cats/package.scala)
+object](https://github.com/typelevel/cats/blob/master/core/src/main/scala/cats/package.scala)
 defines type aliases to the `Semigroup` from algebra, so that you can
 `import cats.semigroup`.
 

diff --git a/docs/src/main/tut/show.md b/docs/src/main/tut/show.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "Show"
 section: "typeclasses"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/Show.scala"
+source: "core/src/main/scala/cats/Show.scala"
 scaladoc: "#cats.Show"
 ---
 # Show

diff --git a/docs/src/main/tut/state.md b/docs/src/main/tut/state.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "State"
 section: "data"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/data/StateT.scala"
+source: "core/src/main/scala/cats/data/StateT.scala"
 scaladoc: "#cats.data.StateT"
 ---
 # State

diff --git a/docs/src/main/tut/streaming.md b/docs/src/main/tut/streaming.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "Streaming"
 section: "data"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/data/Streaming.scala"
+source: "core/src/main/scala/cats/data/Streaming.scala"
 scaladoc: "#cats.data.Streaming"
 ---
 

diff --git a/docs/src/main/tut/traverse.md b/docs/src/main/tut/traverse.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "Traverse"
 section: "typeclasses"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/Traverse.scala"
+source: "core/src/main/scala/cats/Traverse.scala"
 scaladoc: "#cats.Traverse"
 ---
 # Traverse

diff --git a/docs/src/main/tut/validated.md b/docs/src/main/tut/validated.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "Validated"
 section: "data"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/data/Validated.scala"
+source: "core/src/main/scala/cats/data/Validated.scala"
 scaladoc: "#cats.data.Validated"
 ---
 # Validated

diff --git a/docs/src/main/tut/xor.md b/docs/src/main/tut/xor.md
@@ -2,7 +2,7 @@
 layout: default
 title:  "Xor"
 section: "data"
-source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/data/Xor.scala"
+source: "core/src/main/scala/cats/data/Xor.scala"
 scaladoc: "#cats.data.Xor"
 ---
 # Xor

diff --git a/docs/src/site/_config.yml b/docs/src/site/_config.yml
@@ -3,6 +3,7 @@ markdown: redcarpet
 highlighter: pygments
 baseurl: /cats
 apidocs: /cats/api/
+sources: https://github.com/typelevel/cats/blob/master/
 
 collections:
   tut:

diff --git a/docs/src/site/_layouts/default.html b/docs/src/site/_layouts/default.html
@@ -24,9 +24,9 @@
 	<div id="commute"><img src="http://plastic-idolatry.com/erik/cats2.png"/></div>
 	<div id="toolbox">
 	  <table id="tooltable">
-	    <tr><td class="label">Source:</td><td class="link"><a href="https://github.com/non/cats">Github</a></td></tr>
-	    <tr><td class="label">Chat:</td><td class="link"><a href="https://gitter.im/non/cats">Gitter</a></td></tr>
-	    <tr><td class="label">Build:</td><td class="link"><a href="https://travis-ci.org/non/cats">Travis</a></td></tr>
+	    <tr><td class="label">Source:</td><td class="link"><a href="https://github.com/typelevel/cats">Github</a></td></tr>
+	    <tr><td class="label">Chat:</td><td class="link"><a href="https://gitter.im/typelevel/cats">Gitter</a></td></tr>
+	    <tr><td class="label">Build:</td><td class="link"><a href="https://travis-ci.org/typelevel/cats">Travis</a></td></tr>
 	    <tr><td class="label">Api:</td><td class="link"><a href="{{site.apidocs}}">Scaladoc</a></td></tr>
 	  </table>
 	</div>
@@ -46,7 +46,7 @@ <h1>Cats</h1>
 	    <li {%if page.section =="typeclasses" %} class="active" {% else %} class="inactive" {% endif%}>
 	      <a href="{{ site.baseurl }}/typeclasses.html">Typeclasses</a>
 	    </li>
-	    <li {%if page.section =="datatypes" %} class="active" {% else %} class="inactive" {% endif %}>
+	    <li {%if page.section =="data" %} class="active" {% else %} class="inactive" {% endif %}>
 	      <a href="{{ site.baseurl }}/datatypes.html">Data Types</a>
 	    </li>
 	    <li {%if page.section == "resources_for_learners" %} class="active" {% else %} class="inactive" {% endif %}>
@@ -61,12 +61,21 @@ <h1>Cats</h1>
           {{ content }}
 	</div>
       </div>
-      {% if (page.section == 'data') or (page.section == 'typeclasses') and ((page.source != null) or (page.scaladoc != null))%}
-      <div id="extra">
-	<h5>useful links</h5>
+	<!--workaround of poor boolean algebra implementation (see: http://stackoverflow.com/questions/23054564/how-to-use-multiple-arguments-in-an-if-statement-with-liquid?answertab=oldest#tab-top) -->
+	{% if (page.section == 'data') or (page.section == 'typeclasses') %}
+		{% assign linksSection = true %}
+	{% endif %}
+	{% if (page.source != null) or (page.scaladoc != null) %}
+		{% assign linksContent = true %}
+	{% endif %}
+	{% if linksSection and linksContent %}
+	<div id="extra">
+	<h5>Useful links:</h5>
 	<ul>
-	{% if page.source != null %}
+	{% if (page.source != null) and (page.source contains 'https:') %}
 	<li><a href="{{page.source}}">Source</a></li>
+	{% elsif page.source != null %}
+	<li><a href="{{site.sources}}{{page.source}}">Source</a></li>
 	{% endif %}
 	{% if page.scaladoc != null %}
 	<li><a href="{{site.apidocs}}{{ page.scaladoc }}">Scaladoc</a></li>

diff --git a/docs/src/site/css/custom.css b/docs/src/site/css/custom.css
@@ -90,21 +90,31 @@ div#content {
 
 div#extra {
     background: #EEEEFF;
-    width: 150px;
     margin-right: 50px;
-    margin-left: -100%;
     margin-top: 50px;
-#    float: right;
     padding: 10px;
 }
 
+div#extra h5 {
+    display: inline;
+    margin-bottom: 0;
+}
+
 div#extra ul {
+	display:inline;
     list-style-type: none;
     text-align: center;
     margin: 0;
     padding: 0;
 }
 
+div#extra ul li {
+    display: inline;
+    font-weight: bold;
+    font-size: 0.83em;
+    margin-left: 3px;
+}
+
 div#footer {
     clear:left;
 }
@@ -203,14 +213,14 @@ div#navbar li a {
 
 li#active {
     float: left;
-    diplay: inline-block;
+    display: inline-block;
     color: black
     color: white
 
 }
 li#active a {
     float: left;
-    diplay: inline-block;
+    display: inline-block;
     color: black;
     background: white;
 

diff --git a/docs/src/site/datatypes.html → docs/src/site/datatypes.md b/docs/src/site/datatypes.html → docs/src/site/datatypes.md
@@ -3,13 +3,10 @@
 title:  "Data Types"
 section: "data"
 ---
+# Data Types
 
-<h1>Data Types</h1>
-
-<ul>
 {% for x in site.tut %}
   {% if x.section == 'data' %}
-    <li><a href="{{ site.baseurl }}{{ x.url }}">{{ x.title }}</a></li>
+- [{{x.title}}]({{site.baseurl}}{{x.url}})
   {% endif %}
 {% endfor %}
-</ul>
diff --git a/docs/src/site/index.md b/docs/src/site/index.md
@@ -32,7 +32,7 @@ functionality, you can pick-and-choose from amongst these modules
  * `cats-core`: Core type classes and functionality (*required*).
  * `cats-laws`: Laws for testing type class instances.
 
-Release notes for Cats are available in [CHANGES.md](https://github.com/non/cats/blob/master/CHANGES.md).
+Release notes for Cats are available in [CHANGES.md](https://github.com/typelevel/cats/blob/master/CHANGES.md).
 
 <a name "motivations"></a>
 # Motivations
@@ -95,7 +95,7 @@ In an attempt to be more modular, Cats is broken up into a number of sub-project
 
 All code is available to you under the MIT license, available at
 http://opensource.org/licenses/mit-license.php and also in the
-[COPYING](https://raw.githubusercontent.com/non/cats/master/COPYING) file. The design is informed by many other
+[COPYING](https://raw.githubusercontent.com/typelevel/cats/master/COPYING) file. The design is informed by many other
 projects, in particular Scalaz.
 
 Copyright the maintainers, 2015.