Tutorials first #204
Merged
Tutorials first #204
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
Codecov Report
@@ Coverage Diff @@
## master #204 +/- ##
==========================================
+ Coverage 84.60% 84.85% +0.24%
==========================================
Files 19 19
Lines 1604 1604
==========================================
+ Hits 1357 1361 +4
+ Misses 247 243 -4
Continue to review full report at Codecov.
|
|
Good point! I will freshen up that part |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.