Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@ches
Copy link
Contributor

@ches ches commented Jul 24, 2023

Greetings ZIO community,

I've been making a close-reading pass through ZIO core docs, with my text editor close at hand. I find them to be in good shape "in the large"—comprehensive coverage, organization—but to have a lot of speed bumps in the small that I could improve as I go. Style and phrasing are subjective, grammar & syntax are more objective, so I will try to separate these types of changes into PRs that are likely to warrant more or less discussion, respectively.

If still smaller patches would be preferred, let me know.

This one is a first pass of a few sections/chapters on the objective front. Some minor rephrasing may creep in if it fell on the same line as a grammar fix, usually attempting to be more concise, reducing wordiness or repetition.

Disclaimer: I am not a credentialed technical writer, I sometimes might not be able to give better rationale than "it just sounds odd to me as a native English speaker…" 😅

Also, friendly reminder that GitHub has the "rich diffs" toggle that can be useful for reviewing lots of prose changes.

@ches
Copy link
Contributor Author

ches commented Jul 24, 2023

@khajavi since you've done some content overhauls in docs lately, please let me know if there's something you're working on now so I don't duplicate effort on it 🙏🏼

@jdegoes jdegoes merged commit 9f41728 into zio:series/2.x Jul 28, 2023
@ches ches deleted the docs branch September 28, 2023 07:00
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