docs: add goals of the project

tassiluca · Dec 31, 2023 · 8da591c · 8da591c
1 parent 965167a
commit 8da591c
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,6 +1,6 @@
-title: PPS Project @ Unibo
+title: PPS-22-direct-style
 description: Documentation for the PPS project
-baseurL: "/PPS-22-direct-style-experiments"
+baseurl: "/PPS-22-direct-style-experiments/content"
 
 # Rendering
 markdown: kramdown

diff --git a/docs/content/index.md b/docs/content/index.md
@@ -0,0 +1,13 @@
+# Goals
+
+> Develop a few examples (not too complex) using asynchronous constructs and try to implement these examples in the two variants: using the current implementation of futures based on monadic constructs and the style that adopts gears (direct style).
+Analyze aspects such as: 
+> - ergonomicity of the two styles (which one results more thoughtful and/or verbose)
+> - which of the two approaches has a real advantage in adoption, and when
+> - 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
+
+# Content
+
+TBD
diff --git a/docs/content/walkthrough.md b/docs/content/walkthrough.md