Update landing page and started guide

Herb-AI · Sep 5, 2023 · 6c95256 · 6c95256
1 parent 646da48
commit 6c95256
Show file tree

Hide file tree

Showing 12 changed files with 139 additions and 20 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -17,14 +17,19 @@ makedocs(;
     sitename="Herb.jl",
     repo="https://github.com/Herb-AI/Herb.jl",
     pages = [
-        "Home" => "index.md",
+        "Basics" => [
+            "index.md",
+            "install.md",
+            "get_started.md",
+            "concepts.md"
+           ],
         "Sub-Modules" => [
-        "HerbGrammar.jl" => "HerbGrammar.md",
-        "HerbSearch.jl" => "HerbSearch.md",
-        "HerbConstraints.jl" => "HerbConstraints.md",
-        "HerbCore.jl" => "HerbData.md",
-        "HerbEvaluation.jl" => "HerbEvaluation.md",
-        "HerbData.jl" => "HerbData.md",
+            "HerbGrammar.jl" => "HerbGrammar/index.md",
+            "HerbSearch.jl" => "HerbSearch/index.md",
+            "HerbConstraints.jl" => "HerbConstraints/index.md",
+            "HerbCore.jl" => "HerbData/index.md",
+            "HerbEvaluation.jl" => "HerbEvaluation/index.md",
+            "HerbData.jl" => "HerbData/index.md",
        ],
     ],
 )

diff --git a/docs/src/HerbConstraints.md → docs/src/HerbConstraints/index.md b/docs/src/HerbConstraints.md → docs/src/HerbConstraints/index.md
@@ -1,4 +1,4 @@
-# HerbConstraints.jl Documentation
+# [HerbConstraints.jl Documentation](@id HerbConstraints_docs)
 
 ```@meta
 CurrentModule=HerbConstraints

diff --git a/docs/src/HerbCore.md → docs/src/HerbCore/index.md b/docs/src/HerbCore.md → docs/src/HerbCore/index.md
@@ -1,11 +1,11 @@
-# HerbConstraints.jl Documentation
+# [HerbCore.jl Documentation](@id HerbCore_docs)
 
 ```@meta
-CurrentModule=HerbConstraints
+CurrentModule=HerbCore
 ```
 
 ```@autodocs
-Modules = [HerbConstraints]
+Modules = [HerbCore]
 Order   = [:type, :const, :macro, :function]
 ```
 

diff --git a/docs/src/HerbData.md → docs/src/HerbData/index.md b/docs/src/HerbData.md → docs/src/HerbData/index.md
@@ -1,11 +1,11 @@
-# HerbConstraints.jl Documentation
+# [HerbData.jl Documentation](@id HerbData_docs)
 
 ```@meta
-CurrentModule=HerbConstraints
+CurrentModule=HerbData
 ```
 
 ```@autodocs
-Modules = [HerbConstraints]
+Modules = [HerbData]
 Order   = [:type, :const, :macro, :function]
 ```
 

diff --git a/docs/src/HerbEvaluation/index.md b/docs/src/HerbEvaluation/index.md
@@ -0,0 +1,15 @@
+# [HerbEvaluation.jl Documentation](@id HerbEvaluation_docs)
+
+```@meta
+CurrentModule=HerbEvaluation
+```
+
+```@autodocs
+Modules = [HerbEvaluation]
+Order   = [:type, :const, :macro, :function]
+```
+
+## Index
+
+```@index
+```
diff --git a/docs/src/HerbGrammar.md → docs/src/HerbGrammar/index.md b/docs/src/HerbGrammar.md → docs/src/HerbGrammar/index.md
@@ -1,4 +1,4 @@
-# HerbGrammar.jl Documentation
+# [HerbGrammar.jl Documentation](@id HerbGrammar_docs)
 
 ```@meta
 CurrentModule=HerbGrammar

diff --git a/docs/src/HerbSearch.md b/docs/src/HerbSearch.md
diff --git a/docs/src/HerbEvaluation.md → docs/src/HerbSearch/index.md b/docs/src/HerbEvaluation.md → docs/src/HerbSearch/index.md
@@ -1,11 +1,11 @@
-# HerbConstraints.jl Documentation
+# [HerbSearch.jl Documentation](@id HerbSearch_docs)
 
 ```@meta
-CurrentModule=HerbConstraints
+CurrentModule=HerbSearch
 ```
 
 ```@autodocs
-Modules = [HerbConstraints]
+Modules = [HerbSearch]
 Order   = [:type, :const, :macro, :function]
 ```
 

diff --git a/docs/src/concepts.md b/docs/src/concepts.md
@@ -0,0 +1,2 @@
+# Architecture and core concepts
+
diff --git a/docs/src/get_started.md b/docs/src/get_started.md
@@ -0,0 +1,22 @@
+# Getting Started
+
+You can either paste this code into the Julia REPL or into a seperate file, e.g. `get_started.jl`.
+
+```julia
+using HerbSearch, HerbData, HerbInterpret
+
+# define our very simple context-free grammar
+# Can add and multiply an input variable x or the integers 1,2.
+g = @cfgrammar begin
+    Number = |(1:2)
+    Number = x
+    Number = Number + Number
+    Number = Number * Number
+end
+
+problem = Problem([IOExample(Dict(:x => x), 2x+1) for x ∈ 1:5])
+solution = search(g₁, problem, :Number, max_depth=3)
+
+test_with_input(SymbolTable(g₁), solution, Dict(:x => 6))
+```
+
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -2,9 +2,50 @@
 CurrentModule=Herb
 ```
 
-# Herb.jl Documentation
+# [Herb.jl](https://github.com/Herb-AI/Herb.jl)
+*A library for defining and efficiently solving program synthesis tasks in Julia.*
+
+## Why Herb.jl?
+
+When writing research software we almost always investigate highly specific properties or algorithms of our domain, leading to us building the tools from scratch over and over again. The very same holds for the field of program synthesis: Tools are hard to run, benchmarks are hard to get and prepare, and its hard to adapt our existing code to a novel idea.
+
+Herb.jl will take care of this for you and helps you defining, solving and extending your program synthesis problems.
+
+Herb.jl provides...
+- a unified and universal framework for program synthesis
+- `Herb.jl` allows you to describe all sorts of program synthesis problems using context-free grammars
+- a number of state-of-the-art benchmarks and solvers already implemented and usable out-of-the-box
+
+Herb.jl's sub-packages provide fast and easily extendable implementations of 
+- various static and dynamic search strategies,
+- learning search strategies, sampling techniques and more,
+- constraint formulation and propagation, 
+- easy grammar formulation and usage,
+- wide-range of usable program interpreters and languages + the possibility to use your own, and 
+- efficient data formulation.
+
+## Why Julia?
+
+
+## Sub-Modules
+
+Herb's functionality is distributed among several sub-packages:
+- [HerbCore.jl](@ref HerbCore_docs): The core of Herb.jl defining core concepts to avoid circular dependencies.
+- [HerbGrammar.jl](@ref HerbGrammar_docs):
+- [HerbData.jl](@ref HerbData_docs):
+- [HerbEvaluation.jl](@ref HerbEvaluation_docs):
+- [HerbSearch.jl](@ref HerbSearch_docs):
+- [HerbConstraints.jl](@ref HerbConstraints_docs):
+
+
+## Basics:
+
+```@contents
+Pages = [ "def_pomdp.md", "interfaces.md"]
+Depth = 3
+```
+
 
-This is a test.
 
 ```@contents
 ```

diff --git a/docs/src/install.md b/docs/src/install.md
@@ -0,0 +1,34 @@
+# Installation Guide
+
+Before installing Herb.jl, ensure that you have a running Julia distribution installed (Julia version 1.7 and above were tested). 
+
+Thanks to Julia's package management, installing Herb.jl is very straighforward. 
+Activate the default Julia REPL using
+
+```shell
+julia
+```
+
+or from within one of your projects using
+
+```shell
+julia --project=.
+```
+
+From the Julia REPL run 
+```julia
+]
+add Herb
+```
+
+or instead running
+
+```julia
+import Pkg
+Pkg.add("Herb")
+```
+
+which will both install all dependencies automatically.
+
+And just like this you are done! Welcome to Herb.jl!
+