Skip to content

Commit

Permalink
docs(core): improve nx init description (#16245)
Browse files Browse the repository at this point in the history
  • Loading branch information
leosvelperez authored Apr 13, 2023
1 parent 7cff8dc commit 9658fb1
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/generated/cli/init.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: 'init - CLI command'
description: 'Adds nx.json file and installs nx if not installed already'
description: 'Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up distributed caching. For more info, check https://nx.dev/recipes/adopting-nx.'
---

# init

Adds nx.json file and installs nx if not installed already
Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up distributed caching. For more info, check https://nx.dev/recipes/adopting-nx.

## Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/generated/packages/nx/documents/init.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: 'init - CLI command'
description: 'Adds nx.json file and installs nx if not installed already'
description: 'Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up distributed caching. For more info, check https://nx.dev/recipes/adopting-nx.'
---

# init

Adds nx.json file and installs nx if not installed already
Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up distributed caching. For more info, check https://nx.dev/recipes/adopting-nx.

## Usage

Expand Down
3 changes: 2 additions & 1 deletion packages/nx/src/command-line/nx-commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,8 @@ export const commandsObject = yargs
})
.command({
command: 'init',
describe: 'Adds nx.json file and installs nx if not installed already',
describe:
'Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up distributed caching. For more info, check https://nx.dev/recipes/adopting-nx.',
builder: (yargs) => withIntegratedOption(yargs),
handler: async (args: any) => {
await (await import('./init')).initHandler(args);
Expand Down

1 comment on commit 9658fb1

@vercel
Copy link

@vercel vercel bot commented on 9658fb1 Apr 13, 2023

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

nx-dev – ./

nx-five.vercel.app
nx-dev-nrwl.vercel.app
nx.dev
nx-dev-git-master-nrwl.vercel.app

Please sign in to comment.