Write initial user documentation #1197
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
RubenVerborgh
approved these changes
Mar 25, 2022
joachimvh
force-pushed
the
docs/documentation
branch
from
c72e1ff
to
d713867
Compare
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.
馃搧 Related issues
#1174
鉁嶏笍 Description
First attempt at some documentation. Still incomplete and can still be cleaned up a lot, but this way there at least is already something that can be improved upon.
I put it in the
guidesfolder, but I think it might be clearer if we name that folderdocumentation. I do get the potential confusion with the generated TSDoc, but perhaps we should be referring to that documentation explicitly as TSDoc instead?