First micro-site approach #407
Conversation
- Add micro-site settings. - Removes the old docsSettings which tutTargetDirectory was pointing to freestyle. - Fixes some broken links in the references.md file.
…-structure # Conflicts: # project/ProjectPlugin.scala # project/plugins.sbt
docs/src/main/tut/index.md
Outdated
| title: Home | ||
| technologies: | ||
| - first: ["Scala", "Frees-rpc library is completely written in Scala."] | ||
| - second: ["gRPC", "Frees-rpc combine RPC protocols, services and clients thank to gRPC framework."] |
There was a problem hiding this comment.
We need to replace this logo with the gRPC logo, the current one that is being shown is the sbt one.
There was a problem hiding this comment.
Yes, I know about the icon. It is commented in the PR description. Is a provisional one till @israelperezglez provides the right one.
docs/src/main/tut/index.md
Outdated
| technologies: | ||
| - first: ["Scala", "Frees-rpc library is completely written in Scala."] | ||
| - second: ["gRPC", "Frees-rpc combine RPC protocols, services and clients thank to gRPC framework."] | ||
| - third: ["Functional Programming", "Frees-rpc is implemented using the Free Monad and Interpreter pattern."] |
There was a problem hiding this comment.
frees-rpc is a purely functional library for building RPC endpoint based services.
There was a problem hiding this comment.
Ok, done.
|
|
||
| nested_options: | ||
|
|
||
| - title: Quickstart |
There was a problem hiding this comment.
Perhaps we can remove this section since it's no longer providing useful information, pretty much is showing the same menu that the user can find on the left menu.
There was a problem hiding this comment.
When going from the Home to the Documentation section, we can link directly to the Core concepts section.
There was a problem hiding this comment.
Ok, It makes sense
build.sbt
Outdated
| addCompilerPlugin(%%("scalameta-paradise") cross CrossVersion.full), | ||
| libraryDependencies += %%("scalameta", "1.8.0"), | ||
| scalacOptions += "-Xplugin-require:macroparadise" | ||
| ) |
There was a problem hiding this comment.
I think we can remove this entire group of settings:
.settings(
addCompilerPlugin(%%("scalameta-paradise") cross CrossVersion.full),
libraryDependencies += %%("scalameta", "1.8.0"),
scalacOptions += "-Xplugin-require:macroparadise"
)There was a problem hiding this comment.
I will have a look on it
build.sbt
Outdated
| @@ -1,3 +1,4 @@ | |||
| import ProjectPlugin.autoImport.micrositeSettings | |||
There was a problem hiding this comment.
This wouldn't be necessary either
There was a problem hiding this comment.
Removing this import made an ambigous reference to micrositeSettings.
it is imported twice in the same scope by
import ProjectPlugin.autoImport._
and import _root_.freestyle.FreestylePlugin.autoImport._
.settings(micrositeSettings: _*)
To solve this I renamed the value as freesMicrositeSettings
build.sbt
Outdated
| .settings( | ||
| libraryDependencies ++= Seq(%%("scalamockScalatest") % "tut"), | ||
| scalacOptions in Tut ~= (_ filterNot Set("-Ywarn-unused-import", "-Xlint").contains) | ||
| ) | ||
| .enablePlugins(TutPlugin) |
There was a problem hiding this comment.
I think we could remove .enablePlugins(TutPlugin)
There was a problem hiding this comment.
I will have a look on it
This is a first approach for the microsite, we still have to change the tag line in the main page, and add a proper icon for gRPC in the technologies section.
This PR:
tutTargetDirectorywas pointing to freestyle.