Skip to content

Update documentation to have CLI instructions before the usage #199

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

Merged
merged 4 commits into from
Jul 21, 2021

Conversation

iepsen
Copy link
Contributor

@iepsen iepsen commented Mar 24, 2021

Why?

This is a suggestion to improve the communication about the React Native CLI. As it works only with the new CLI, it seems to be a requirement instead of a note.

The goal here is to avoid issues like this one facebook/react-native#31054.

@iepsen iepsen requested review from emin93 and radko93 as code owners March 24, 2021 09:19
@emin93
Copy link
Member

emin93 commented Jul 20, 2021

Wow, it has been already 4 months since you opened this PR. Thank you for the patience.

Generally I can see where your motivation comes from. Fun fact, when the new CLI was released this note has already been up there. And guess what, people still reported the same error over and over again... 😄

In the meantime the new CLI is also not so new anymore (out for over 2 years) and I feel it would be too distracting for the majority of developers that already use the latest CLI.

It's not like the info isn't there, it's just not at the beginning of the usage section. I think it's fair to expect anyone to read the whole README.md as it's quite small, especially if issues occur.

@emin93 emin93 closed this Jul 20, 2021
@emin93
Copy link
Member

emin93 commented Jul 20, 2021

Having that said, I think I would be fine renaming the title from "Note on the Legacy CLI" to something like "Requirements". Feel free to reopen this PR if you agree with that.

@leotm
Copy link
Contributor

leotm commented Jul 20, 2021

Notatebly #80

Good stuff 👊

@emin93 emin93 reopened this Jul 20, 2021
Copy link
Member

@emin93 emin93 left a comment

Choose a reason for hiding this comment

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

Actually, I like the simple changes to make it feel less like an optional "note". Which is why I reopened this PR.

We should also add the hint about the --ignore-existing flag for people using npx with the old CLI. (#80 (comment))

The only thing I wouldn't want to change is moving it above the actual usage for the reasons stated in the previous comment.

@iepsen
Copy link
Contributor Author

iepsen commented Jul 21, 2021

Thanks for looking into this @emin93. I have now pushed two commits to move back the legacy CLI warning and added the --ignore-existing instructions.

@emin93 emin93 merged commit d66ebbf into react-native-community:master Jul 21, 2021
@iepsen iepsen deleted the update-docs-legacy-cli branch July 21, 2021 09:51
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.

3 participants