Improve docs (#58)

* tmp commit

* tmp commit

* tmp commit

* tmp commit

* tls

* non uniform workload for channels variants

* reorganization + minor fixes

* rc

* minor fix

* changelog

CHANGELOG.md

@@ -1,6 +1,11 @@
 OhMyThreads.jl Changelog
 =========================
 
+Version 0.4.5
+-------------
+
+- ![Enhancement][badge-enhancement] Improved the thread-safe storage section of the documentation.
+
 Version 0.4.4
 -------------
 

README.md

@@ -66,7 +66,7 @@ Timings might be something like this:
 89.401 ms (66 allocations: 5.72 KiB)
 ```
 
-(Check out the full [Parallel Monte Carlo](https://juliafolds2.github.io/OhMyThreads.jl/stable/examples/mc/mc/) example if you like.)
+(Check out the full [Parallel Monte Carlo](https://juliafolds2.github.io/OhMyThreads.jl/stable/literate/mc/mc/) example if you like.)
 
 ## Documentation
 

docs/make.jl

@@ -12,26 +12,28 @@ makedocs(;
     doctest = false,
     pages = [
         "OhMyThreads" => "index.md",
-         "Examples" => [
-             "Parallel Monte Carlo" => "examples/mc/mc.md",
-             "Julia Set" => "examples/juliaset/juliaset.md",
-             "Trapezoidal Integration" => "examples/integration/integration.md",
-         ],
         "Translation Guide" => "translation.md",
-        "Task-Local Storage" => "examples/tls/tls.md",
+        "Thread-Safe Storage" => "literate/tls/tls.md",
+        "Examples" => [
+            "Parallel Monte Carlo" => "literate/mc/mc.md",
+            "Julia Set" => "literate/juliaset/juliaset.md",
+            "Trapezoidal Integration" => "literate/integration/integration.md"
+        ],
+        # "Explanations" => [
+        #     "Task-Based Multithreading" => "explain/taskbasedmt.md",
+        # ],
         "API" => [
             "Public API" => "refs/api.md",
-            "Internal" => "refs/internal.md",
-        ],
+            "Internal" => "refs/internal.md"
+        ]
     ],
     repo = "https://github.com/JuliaFolds2/OhMyThreads.jl/blob/{commit}{path}#{line}",
-    format = Documenter.HTML(repolink = "https://github.com/JuliaFolds2/OhMyThreads.jl";
-        collapselevel = 1))
+    format = Documenter.HTML(repolink = "https://github.com/JuliaFolds2/OhMyThreads.jl"))
 
 if ci
     @info "Deploying documentation to GitHub"
     deploydocs(;
         repo = "github.com/JuliaFolds2/OhMyThreads.jl.git",
         devbranch = "master",
-        push_preview = true,)
+        push_preview = true)
 end

docs/src/basics.md

@@ -0,0 +1,3 @@
+# Basics
+
+This section is still in preparation. For now, you might want to take a look at the [translation guide](@ref TG) and the examples.