From 72be10d7525f920f4ca00085939d5eef2a01ec52 Mon Sep 17 00:00:00 2001 From: Christopher Rackauckas Date: Fri, 17 Jul 2020 23:11:33 -0400 Subject: [PATCH] Tutorials first I always think a tutorials first approach to documentation is much more inviting, because it becomes immediately clear to the user (a) what is solved and (b) how to use it. All of the extra details of what other things you can choose to do can come after the tutorial, but most people want to just look at the first tutorial, copy/paste, and run. With that in mind, I think the first tutorial could use a bit more. I think a demonstration of surrogate optimization should appear in that first page, otherwise most people won't know it exists. --- docs/make.jl | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index 1ce68a82e..5abaa1cc7 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -3,11 +3,6 @@ makedocs( sitename="Surrogates.jl", pages = [ "index.md" - "User guide" => [ - "Samples" => "samples.md", - "Surrogates" => "surrogate.md", - "Optimization" => "optimizations.md" - ] "Tutorials" => [ "Basics" => "tutorials.md", "RandomForestSurrogate" => "randomforest.md", @@ -17,6 +12,11 @@ makedocs( "LinearSurrogate" => "LinearSurrogate.md", "InverseDistance" => "InverseDistance.md" ] + "User guide" => [ + "Samples" => "samples.md", + "Surrogates" => "surrogate.md", + "Optimization" => "optimizations.md" + ] "Benchmarks" => [ "Sphere function" => "sphere_function.md" ]