Update and fix docs

xebia-functional · Aug 4, 2017 · 146cdec · 146cdec
1 parent 00521a6
commit 146cdec
Show file tree

Hide file tree

Showing 41 changed files with 187 additions and 191 deletions.
diff --git a/README.md b/README.md
@@ -1,17 +1,17 @@
-### *Macroid* — a Scala GUI DSL for Android
+### Macroid — a Scala GUI DSL for Android
 
 [![Build Status](https://travis-ci.org/47deg/macroid.png?branch=master)](https://travis-ci.org/47deg/macroid) [![Codacy Badge](https://www.codacy.com/project/badge/fb3d939567d04686bfb23da3a22b9de9)](https://www.codacy.com/public/nickstanch/macroid) [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Macroid-brightgreen.svg?style=flat)](https://android-arsenal.com/details/1/1529) [![Join the chat at https://gitter.im/macroid/macroid](https://img.shields.io/badge/GITTER-Join%20chat%20→-brightgreen.svg?style=flat)](https://gitter.im/macroid/macroid?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-*Macroid* is the most badass modular functional user interface creation language for Android, implemented with Scala macros.
+Macroid is the most badass modular functional user interface creation language for Android, implemented with Scala macros.
 [Some people say](http://www.urbandictionary.com/define.php?term=macroid) it’s also a dead noodle.
 
-Striving to be focused on one thing (GUI), *Macroid* promotes composability and high-level abstractions.
+Striving to be focused on one thing (GUI), Macroid promotes composability and high-level abstractions.
 
 Prerequisites: Scala `2.10.x` or `2.11.x`, Android `API 9+`.
 
-Latest version: `2.0`
+Latest version: `2.1.0`
 
-Snapshot version: `2.0.1-SNAPSHOT`
+Snapshot version: `2.1.0-SNAPSHOT`
 
 License: [MIT](http://opensource.org/licenses/MIT).
 
@@ -27,7 +27,7 @@ For more info head to http://47deg.github.io/macroid!
 ```scala
 
 libraryDependencies ++= Seq(
-  aar("org.macroid" %% "macroid" % "2.0")
+  aar("org.macroid" %% "macroid" % "2.1.0")
 
 ```
 
@@ -39,7 +39,7 @@ resolvers +=
   "Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots"
 
 libraryDependencies ++= Seq(
-  aar("org.macroid" %% "macroid" % "2.0.1-SNAPSHOT")
+  aar("org.macroid" %% "macroid" % "2.1.0-SNAPSHOT")
 
 ```
 
@@ -49,7 +49,7 @@ All contributions are welcome (and encouraged)!
 
 ##### Commit messages
 
-*Macroid*’s commit message structure is [inspired by the Spray project](http://spray.io/project-info/contributing/#git-commit-messages). The message has the following format:
+Macroid’s commit message structure is [inspired by the Spray project](http://spray.io/project-info/contributing/#git-commit-messages). The message has the following format:
 ```
 [=|+|!] [core|viewable|akka|docs|all]: <Actual message>.
 ```

diff --git a/build.sbt b/build.sbt
@@ -19,76 +19,76 @@ lazy val macroid = (project in file("."))
   )
 
 lazy val core = (project in file("macroid-core"))
-    .enablePlugins(AndroidLib)
-    .settings(commonSettings: _*)
-    .settings(macroSettings: _*)
-    .settings(
-      name := "macroid",
-      description := "A Scala GUI DSL for Android",
-      homepage := Some(url("http://47deg.github.io/macroid")),
-      platformTarget in Android := platformV,
-      unmanagedClasspath in Test ++= (bootClasspath in Android).value,
-      unmanagedSourceDirectories in Test := Seq(
-        baseDirectory.value / "src" / "test" / "scala"),
-      libraryDependencies ++= Seq(
-        "org.scala-lang.modules" %% "scala-async" % "0.9.6"
-      )
+  .enablePlugins(AndroidLib)
+  .settings(commonSettings: _*)
+  .settings(macroSettings: _*)
+  .settings(
+    name := "macroid",
+    description := "A Scala GUI DSL for Android",
+    homepage := Some(url("http://47deg.github.io/macroid")),
+    platformTarget in Android := platformV,
+    unmanagedClasspath in Test ++= (bootClasspath in Android).value,
+    unmanagedSourceDirectories in Test := Seq(
+      baseDirectory.value / "src" / "test" / "scala"),
+    libraryDependencies ++= Seq(
+      "org.scala-lang.modules" %% "scala-async" % "0.9.6"
     )
+  )
 
 lazy val viewable = (project in file("macroid-viewable"))
-    .enablePlugins(AndroidLib)
-    .settings(commonSettings: _*)
-    .settings(
-      name := "macroid-viewable",
-      description := "Typeclasses to turn data into Android layouts",
-      platformTarget in Android := platformV,
-      unmanagedClasspath in Test ++= (bootClasspath in Android).value,
-      homepage := Some(
-        url("http://47deg.github.io/macroid/docs/modules/Viewable.html"))
-    )
-    .dependsOn(core)
+  .enablePlugins(AndroidLib)
+  .settings(commonSettings: _*)
+  .settings(
+    name := "macroid-viewable",
+    description := "Typeclasses to turn data into Android layouts",
+    platformTarget in Android := platformV,
+    unmanagedClasspath in Test ++= (bootClasspath in Android).value,
+    homepage := Some(
+      url("http://47deg.github.io/macroid/docs/modules/Viewable.html"))
+  )
+  .dependsOn(core)
 
 lazy val akka = (project in file("macroid-akka"))
-    .enablePlugins(AndroidLib)
-    .settings(commonSettings: _*)
-    .settings(
-      name := "macroid-akka",
-      description := "Helpers to attach Akka Actors to Android Fragments",
-      platformTarget in Android := platformV,
-      unmanagedClasspath in Test ++= (bootClasspath in Android).value,
-      homepage := Some(
-        url("http://47deg.github.io/macroid/docs/modules/Akka.html")),
-      libraryDependencies += "com.typesafe.akka" %% "akka-actor" % "2.5.3"
-    )
-    .dependsOn(core)
+  .enablePlugins(AndroidLib)
+  .settings(commonSettings: _*)
+  .settings(
+    name := "macroid-akka",
+    description := "Helpers to attach Akka Actors to Android Fragments",
+    platformTarget in Android := platformV,
+    unmanagedClasspath in Test ++= (bootClasspath in Android).value,
+    homepage := Some(
+      url("http://47deg.github.io/macroid/docs/modules/Akka.html")),
+    libraryDependencies += "com.typesafe.akka" %% "akka-actor" % "2.5.3"
+  )
+  .dependsOn(core)
 
 lazy val docs = (project in file("macroid-docs"))
-    .enablePlugins(AndroidLib)
-    .settings(commonSettings: _*)
-    .settings(micrositeSettings: _*)
-    .settings(moduleName := "macroid-docs")
-    .enablePlugins(MicrositesPlugin)
-    .settings(name := "docs",
-      platformTarget in Android := platformV,
-      unmanagedClasspath in Test ++= (bootClasspath in Android).value,
-      description := "Macroid Documentation")
-    .dependsOn(core)
+  .enablePlugins(AndroidLib)
+  .settings(commonSettings: _*)
+  .settings(micrositeSettings: _*)
+  .settings(moduleName := "macroid-docs")
+  .enablePlugins(MicrositesPlugin)
+  .settings(name := "docs",
+            platformTarget in Android := platformV,
+            unmanagedClasspath in Test ++= (bootClasspath in Android).value,
+            description := "Macroid Documentation")
+  .dependsOn(core)
 
 lazy val extras = (project in file("macroid-extras"))
-    .enablePlugins(AndroidLib)
-    .settings(commonSettings: _*)
-    .settings(
-      name := "macroid-extras",
-      description := "Tweaks and utilities for android views",
-      platformTarget in Android := platformV,
-      unmanagedClasspath in Test ++= (bootClasspath in Android).value,
-      homepage := Some(
-        url("http://47deg.github.io/macroid/docs/modules/Extras.html")),
-      libraryDependencies ++= Seq(
-        "com.android.support" % "appcompat-v7" % androidV,
-        "com.android.support" % "recyclerview-v7" % androidV,
-        "com.android.support" % "cardview-v7" % androidV,
-        "com.android.support" % "design" % androidV
-      )
+  .enablePlugins(AndroidLib)
+  .settings(commonSettings: _*)
+  .settings(
+    name := "macroid-extras",
+    description := "Tweaks and utilities for android views",
+    platformTarget in Android := platformV,
+    unmanagedClasspath in Test ++= (bootClasspath in Android).value,
+    homepage := Some(
+      url("http://47deg.github.io/macroid/docs/modules/Extras.html")),
+    libraryDependencies ++= Seq(
+      "com.android.support" % "appcompat-v7" % androidV,
+      "com.android.support" % "recyclerview-v7" % androidV,
+      "com.android.support" % "cardview-v7" % androidV,
+      "com.android.support" % "design" % androidV
     )
-    .dependsOn(core)
+  )
+  .dependsOn(core)
diff --git a/macroid-akka/README.md b/macroid-akka/README.md
@@ -4,15 +4,15 @@ This module contains some glue to setup message-passing between Android Fragment
 
 #### Installation
 
-Assuming you already have *Macroid* `2.0.0-M4` installed, add this line to your `build.sbt`:
+Assuming you already have Macroid `2.1.0` installed, add this line to your `build.sbt`:
 
 ```scala
 libraryDependencies ++= Seq(
   // this library
-  aar("org.macroid" %% "macroid-akka" % "2.0.0-M4"),
+  aar("org.macroid" %% "macroid-akka" % "2.1.0"),
 
   // akka, if not included before
-  "com.typesafe.akka" %% "akka-actor" % "2.2.3"
+  "com.typesafe.akka" %% "akka-actor" % "2.5.3"
 )
 
 // Proguard rules

diff --git a/macroid-docs/src/main/resources/microsite/data/menu.yml b/macroid-docs/src/main/resources/microsite/data/menu.yml
@@ -1,90 +1,85 @@
 options:
   - title: Introduction
-    url: index.html
+    url: docs.html
 
   - title: Installation
-    url: Installation.html
-    section: installation
+    url: installation.html
 
     nested_options:
      - title: Scala on Android
-       url: installation/ScalaOnAndroid.html
+       url: installation/scalaOnAndroid.html
 
   - title: Tutorial
-    url: Tutorial.html
-    section: tutorial
+    url: tutorial.html
 
     nested_options:
      - title: Building layouts
-       url: tutorial/BuildingLayouts.html
+       url: tutorial/buildingLayouts.html
      - title: Tweaking widgets
-       url: tutorial/Tweaking.html
+       url: tutorial/tweaking.html
      - title: Handling events
-       url: tutorial/HandlingEvents.html
+       url: tutorial/handlingEvents.html
      - title: Getting adaptive
-       url: tutorial/GettingAdaptive.html
+       url: tutorial/gettingAdaptive.html
      - title: Complete code
-       url: tutorial/CompleteCode.html
+       url: tutorial/completeCode.html
 
   - title: Guide
-    url: Guide.html
-    section: guide
+    url: guide.html
 
     nested_options:
      - title: UI actions
-       url: guide/UiActions.html
+       url: guide/uiActions.html
      - title: Contexts
-       url: guide/Contexts.html
+       url: guide/contexts.html
      - title: Bricks
-       url: guide/Bricks.html
+       url: guide/bricks.html
      - title: Tweaks
-       url: guide/Tweaks.html
+       url: guide/tweaks.html
      - title: Snails
-       url: guide/Snails.html
+       url: guide/snails.html
      - title: Transformers
-       url: guide/Transformers.html
+       url: guide/transformers.html
      - title: Understand operators
-       url: guide/Operators.html
+       url: guide/operators.html
      - title: Media queries
-       url: guide/MediaQueries.html
+       url: guide/mediaQueries.html
      - title: Fragments
-       url: guide/Fragments.html
+       url: guide/fragments.html
      - title: Searching
-       url: guide/Searching.html
+       url: guide/searching.html
      - title: Toasts and dialogs
-       url: guide/ToastsDialogs.html
+       url: guide/toastsDialogs.html
      - title: Advances techniques
-       url: guide/Advanced.html
+       url: guide/advanced.html
      - title: Imports
-       url: guide/Imports.html
+       url: guide/imports.html
 
   - title: Modules
-    url: Modules.html
-    section: modules
+    url: modules.html
 
     nested_options:
      - title: Viewable
-       url: modules/Viewable.html
+       url: modules/viewable.html
      - title: Akka Integration
-       url: modules/Akka.html
+       url: modules/akka.html
      - title: Extras
-       url: modules/Extras.html
+       url: modules/extras.html
 
   - title: Differences from
-    url: Differences.html
-    section: differences
+    url: differences.html
 
     nested_options:
      - title: Vanilla Android
-       url: differences/Vanilla.html
+       url: differences/vanilla.html
      - title: Scaloid
-       url: differences/Scaloid.html
+       url: differences/scaloid.html
 
   - title: Sample Projects
-    url: Samples.html
+    url: samples.html
 
   - title: Talks
-    url: Talks.html
+    url: talks.html
 
   - title: Changelog
-    url: Changelog.html
+    url: changelog.html
diff --git a/macroid-docs/src/main/tut/docs/Changelog.md → macroid-docs/src/main/tut/docs/changelog.md b/macroid-docs/src/main/tut/docs/Changelog.md → macroid-docs/src/main/tut/docs/changelog.md
@@ -19,7 +19,7 @@ Detailed diff can be found [on GitHub](https://github.com/macroid/macroid/compar
 
 ### All modules
 
-All *Macroid* modules now reside in the same repository and take advantage of a unified build setup.
+All Macroid modules now reside in the same repository and take advantage of a unified build setup.
 Note that commit history has been rewritten to include references to the relevant modules in the commit messages.
 
 ### Core

diff --git a/...oid-docs/src/main/tut/docs/Differences.md → ...oid-docs/src/main/tut/docs/differences.md b/...oid-docs/src/main/tut/docs/Differences.md → ...oid-docs/src/main/tut/docs/differences.md
@@ -6,7 +6,7 @@ section: docs
 
 # Differences from...
 
-These pages explain why I built *Macroid* and how it’s different from what you may have known before:
+These pages explain why I built Macroid and how it’s different from what you may have known before:
 
 * [Vanilla Android](differences/Vanilla.html)
 * [Scaloid](differences/Scaloid.html)