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

Documentation Improvements #4

Merged
merged 3 commits into from
Mar 19, 2021
Merged

Conversation

CleanCut
Copy link

@CleanCut CleanCut commented Mar 14, 2021

This is my quick attempt at improving the existing migration docs so that they follow conventions similar to the latest blog post (author attribution, doc links for interesting bare items). I also tried to make some wording more straightforward and fixed at least one typo.

/cc @cart

@cart
Copy link
Owner

cart commented Mar 17, 2021

I'm not a huge fan of adding attribution here:

  1. Migration is a "negative" context. It is "work" we're making our users do. If we add attribution here, people might subconsciously (or consciously) blame @user for the work being done.
  2. This doesn't showcase the features themselves, only how they break
  3. We already have blog posts for attribution. I see no need to double up here.

@CleanCut
Copy link
Author

Sure thing. It sounds like the migration guide is not an extension of the blog post, it's a separate document specifically for what to look out for during migration.

With that in mind, it sounds like I should remove the section about StopWatch? It's new, so there's nothing it should break.

Are you looking for more comprehensive documentation? Like tables of "this method signature" -> "that method signature" for Timer?

@cart
Copy link
Owner

cart commented Mar 19, 2021

With that in mind, it sounds like I should remove the section about StopWatch? It's new, so there's nothing it should break.

Yeah lets remove the StopWatch section as its an entirely new feature.

Are you looking for more comprehensive documentation? Like tables of "this method signature" -> "that method signature" for Timer?

I think what you currently have strikes a good balance between explicitness and terseness. It covers the common case explicitly and gives people a jumping off point for everything else. I think once you remove the attribution line we're good to go.

@cart cart merged commit 0dcaf2a into cart:migration-guide-0.5 Mar 19, 2021
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