From e7b98b6a7433c9cc5a219276abf07698b3fc580f Mon Sep 17 00:00:00 2001 From: Luca Tassinari Date: Mon, 4 Mar 2024 21:29:56 +0100 Subject: [PATCH] docs: adjusted project name --- README.md | 5 ++--- docs/content/_index.md | 7 +++---- docs/content/docs/01-boundaries.md | 2 ++ docs/hugo.toml | 6 +++--- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6c52c922..e8422f6a 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,7 @@ > - ergonomics of the two styles (which one results more thoughtful and/or verbose); > - which of the two approaches has a real advantage in adoption; > - pros and cons of the two styles; -> - how and when to use one approach rather than the other; -> - any limitations and difficulties encountered in using them; +> - any limitations and difficulties encountered in using them. ## Overview @@ -58,6 +57,6 @@ Generally speaking, the runnable examples can be run by simply executing the `ru ./gradlew :analyzer-direct:run ``` -Detailed instructions follows in the specific sections. +Detailed instructions follows in the specific sections (and in `README`). **Examples works with a version of the JDK > 21** (Virtual Threads are needed!). \ No newline at end of file diff --git a/docs/content/_index.md b/docs/content/_index.md index 6c52c922..8c0f0c09 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -11,8 +11,7 @@ > - ergonomics of the two styles (which one results more thoughtful and/or verbose); > - which of the two approaches has a real advantage in adoption; > - pros and cons of the two styles; -> - how and when to use one approach rather than the other; -> - any limitations and difficulties encountered in using them; +> - any limitations and difficulties encountered in using them. ## Overview @@ -58,6 +57,6 @@ Generally speaking, the runnable examples can be run by simply executing the `ru ./gradlew :analyzer-direct:run ``` -Detailed instructions follows in the specific sections. +Detailed instructions follows in the specific sections (and in `README`). -**Examples works with a version of the JDK > 21** (Virtual Threads are needed!). \ No newline at end of file +**Examples works with a version of the JDK > 21** (Virtual Threads are needed!). diff --git a/docs/content/docs/01-boundaries.md b/docs/content/docs/01-boundaries.md index 6dfcc853..a95aa3aa 100644 --- a/docs/content/docs/01-boundaries.md +++ b/docs/content/docs/01-boundaries.md @@ -64,6 +64,8 @@ object optional: ### `Either` + `?` +[[Here you can find the full source]()] + ```scala /** Represents a computation that will hopefully return a [[Right]] value but might fail with a [[Left]] one.*/ object either: diff --git a/docs/hugo.toml b/docs/hugo.toml index e9c24c53..4e394b0f 100644 --- a/docs/hugo.toml +++ b/docs/hugo.toml @@ -1,6 +1,6 @@ -baseURL = 'https://tassiluca.github.io/PPS-22-direct-style-experiments/' +baseURL = 'https://tassiluca.github.io/direct-style-experiments/' languageCode = 'en-us' -title = 'PPS-22-direct-style-experiments' +title = 'direct-style-experiments' enableGitInfo = true # to enable 'Last Modified by' date and git author information on 'doc' type pages. @@ -16,5 +16,5 @@ enableGitInfo = true # to enable 'Last Modified by' date and git author informat [params] BookTheme = 'light' - BookRepo = 'https://github.com/tassiLuca/PPS-22-direct-style-experiments' # used for 'Last Modified' and 'Edit this page' links + BookRepo = 'https://github.com/tassiLuca/direct-style-experiments' # used for 'Last Modified' and 'Edit this page' links BookCommitPath = 'commit'