-
Notifications
You must be signed in to change notification settings - Fork 172
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc cleaning #729
doc cleaning #729
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One typo and a suggestion to cut a little more material. It's fine with me if you prefer to just fix the typo.
Looks like you've done a bunch of new work here in the revision. Can you clean up the history so the additions vs. cleanup changes are well described in the commit log and then I'll take another look. |
Squashed and gave new commit message. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! Couple of minor things to cleanup.
Also, one more thing on the commit message. We want the first line to be a summary no longer than (about) 50 characters and then the rest goes in "the body" after a line break. So in this case something like:
Condense docs and add info on reading/writing data
Also:
* Condenses & moves the FAQ doc into better location
* Improves the table of contents ordering to be more logical
Nice explanation of the how and why of good commit messages here: https://cbea.ms/git-commit/
Also: * Condenses & moves the FAQ doc into better location * Improves the table of contents ordering to be more logical
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
@henrykironde - I'm going to merge this. You'll want to rebase any of the docs work you're doing on this since it does change the Table of Contents |
While on the plane, I went through docs and improved wording.