Update docs with tutorials and how-to sections #569
Merged
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
guilhermeleobas
force-pushed
the
guilhermeleobas/update-docs
branch
from
a7fcdb3
to
130e1c4
Compare
guilhermeleobas
force-pushed
the
guilhermeleobas/update-docs
branch
2 times, most recently
from
50cf2e6
to
6244b29
Compare
guilhermeleobas
force-pushed
the
guilhermeleobas/update-docs
branch
from
28524d0
to
f236c01
Compare
brenocfg
reviewed
Jul 10, 2023
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.
This pull request adds two new sections to RBC ReadTheDocs page:
This refactoring aims to enhance the clarity and structure of the text, and it is based on diataxis guide on documentation. How-to guides are supposed to be concise and provide direct answers to specific questions (i.e. "How to connect to the HeavyDB server"). On the other hand, tutorials should be more comprehensive and in-depth exploration of a subject.