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

[Document Request] Add a migration guide for byebug users #644

Closed
st0012 opened this issue May 25, 2022 · 3 comments · Fixed by #770
Closed

[Document Request] Add a migration guide for byebug users #644

st0012 opened this issue May 25, 2022 · 3 comments · Fixed by #770

Comments

@st0012
Copy link
Member

st0012 commented May 25, 2022

What

  1. Add a document docs/migrate_from_byebug.md as the migration guide for byebug users.
  2. Add a link to it in the readme

Content

  • It should list command comparisons, especially around step debugging, to help users learn what's changed or not changed.
    • Preferably using markdown table for this instead of a separate page to optimize reader's experience.
  • It should also emphasize the features that're unique to the debugger as an attraction.

Why

Based on the latest Rails community survey, byebug has 30% of the market share vs debugger's 10%. Given that byebug and the debugger share the same user base, a migration guide should help speed up the adoption.

Screenshot 2022-05-25 at 14 56 46

Additional context

  • I know there's already a debug command comparison sheet. It'll be a nice supporting material but it's not specific for byebug. So I think it can't replace the migration guide I mentioned above.
  • If there's no objection on this idea, I'll work on it.
@st0012 st0012 changed the title [Documentation] Add a migration guide for byebug users [Document Request] Add a migration guide for byebug users May 25, 2022
@ko1
Copy link
Collaborator

ko1 commented Jul 5, 2022

I don't have objection.

Some points:

  • byebug has still advantages so I don't think all users should not migrate from byebug if users feel byebug is enough. Showing both advantages seems important and user can choose their own favorite.
  • If it is written in a blog post, it is easy to manage by @st0012 and the author is clear. I'm happy to link to the post. If doc is in the repository, I will check the contents.

@st0012
Copy link
Member Author

st0012 commented Aug 10, 2022

I've written this post as suggested 😄
It also mentions a few points on "why users should not migrate". But I think the migration should be beneficial in general.

@ko1
Copy link
Collaborator

ko1 commented Sep 16, 2022

Thank you, could you give me a PR to merge this link in README?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging a pull request may close this issue.

2 participants