Skip to content

Commit

Permalink
Tutorials first
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
ChrisRackauckas committed Jul 18, 2020
1 parent 5e817a7 commit 4630fb3
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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"
]
Expand Down

0 comments on commit 4630fb3

Please sign in to comment.