Skip to content
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

Merged
merged 1 commit into from
Aug 6, 2024
Merged

doc cleaning #729

merged 1 commit into from
Aug 6, 2024

Conversation

bw4sz
Copy link
Collaborator

@bw4sz bw4sz commented Jul 29, 2024

While on the plane, I went through docs and improved wording.

Copy link
Member

@ethanwhite ethanwhite left a 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.

docs/training.md Outdated Show resolved Hide resolved
docs/annotation.md Outdated Show resolved Hide resolved
@ethanwhite
Copy link
Member

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.

@bw4sz
Copy link
Collaborator Author

bw4sz commented Aug 5, 2024

Squashed and gave new commit message.

Copy link
Member

@ethanwhite ethanwhite left a 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/

docs/Reading_and_Writing.md Outdated Show resolved Hide resolved
docs/Reading_and_Writing.md Outdated Show resolved Hide resolved
docs/training.md Show resolved Hide resolved
docs/training.md Outdated Show resolved Hide resolved
docs/training.md Show resolved Hide resolved
Also:
* Condenses & moves the FAQ doc into better location
* Improves the table of contents ordering to be more logical
Copy link
Member

@ethanwhite ethanwhite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ethanwhite
Copy link
Member

@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

@ethanwhite ethanwhite merged commit 7eb462c into main Aug 6, 2024
5 checks passed
@henrykironde henrykironde deleted the improve_docs branch August 6, 2024 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants