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

nx init: options not found in the documentation. #16251

Closed
1 of 4 tasks
Sygnious opened this issue Apr 12, 2023 · 3 comments · Fixed by #16433
Closed
1 of 4 tasks

nx init: options not found in the documentation. #16251

Sygnious opened this issue Apr 12, 2023 · 3 comments · Fixed by #16433
Assignees
Labels

Comments

@Sygnious
Copy link

Sygnious commented Apr 12, 2023

Documentation issue

  • Reporting a typo
  • Reporting a documentation bug
  • Documentation improvement
  • Documentation feedback

Is there a specific documentation page you are reporting?

https://nx.dev/packages/nx/documents/init#usage

Additional context or description

The documentation page for nx init is lacking the options. I knew from the guide Migrating from CRA to NX that there exist options such as "--integrated" or "--vite=false", but none of them are mentioned in the documentation itself for nx init.

In my case, I needed the "--nxCloud=false" option, as I have reasons for not adding cloud caching to my migration. Since it's not in the documentation, I had to dig around in the source code to find the remaining options, and then test it out.

This is very cumbersome for those of us who is migrating from CRA (or any other standalone app), when we need to do adjustments to the migration.

I hereby request that the documentation page is filled with the options available.

@AgentEnder AgentEnder added the scope: core core nx functionality label Apr 12, 2023
@AgentEnder
Copy link
Member

I believe this in-flight PR will address this: #16245

@leosvelperez leosvelperez self-assigned this Apr 12, 2023
@leosvelperez
Copy link
Member

Yeah, the nx init documentation will be improved in a couple of PRs. The #16245 is one part of the improvements, but that one doesn't address the missing options. That would be included in another PR I'll be creating later.

@github-actions
Copy link

This issue has been closed for more than 30 days. If this issue is still occuring, please open a new issue with more recent context.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 28, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants