Fix up some docs, add an faqs doc #1121
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
Motivation: Documentation is -- generally speaking -- useful. More so when it's correct. Modifications: - Add some missing documentation. There's still more to go but it's a start. - Add an 'faqs' doc which answers some questions which aren't necessarily obvious from reading source documentation. It's in no way comprehensive and is intended to be built upon over time. - Remove some dead code. Result: Better docs, hopefully.
Lukasa
approved these changes
Jan 29, 2021
Co-authored-by: Cory Benfield <[email protected]>
Davidde94
approved these changes
Jan 29, 2021
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.
Motivation:
Documentation is -- generally speaking -- useful. More so when it's
correct.
Modifications:
start.
obvious from reading source documentation. It's in no way
comprehensive and is intended to be built upon over time.
Result:
Better docs, hopefully.