Skip to content

Commit e3eedf9

Browse files
authored
docs(misc): update the docs to use more direct language (#34264)
<!-- Please make sure you have read the submission guidelines before posting an PR --> <!-- https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr --> <!-- Please make sure that your commit message follows our format --> <!-- Example: `fix(nx): must begin with lowercase` --> <!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. --> ## Current Behavior <!-- This is the behavior we have today --> ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #
1 parent eb678bf commit e3eedf9

109 files changed

Lines changed: 180 additions & 172 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<p style="text-align: center;">
22
<picture>
33
<source media="(prefers-color-scheme: dark)" srcset="./images/nx-dark.svg">
4-
<img alt="Nx - Smart Repos · Fast Builds" src="./images/nx-light.svg" width="100%">
4+
<img alt="Nx - Smart Monorepos · Fast Builds" src="./images/nx-light.svg" width="100%">
55
</picture>
66
</p>
77

@@ -19,7 +19,7 @@
1919

2020
<hr>
2121

22-
# Smart Repos · Fast Builds
22+
# Smart Monorepos · Fast Builds
2323

2424
Get to green PRs in half the time. Nx optimizes your builds, scales your CI, and fixes failed PRs. Built for developers and AI agents.
2525

@@ -58,7 +58,7 @@ Learn more in the [Nx CI docs &raquo;](https://nx.dev/ci/getting-started/intro?u
5858
- [Our Twitter/X](https://x.com/nxdevtools)
5959

6060
<p style="text-align: center;"><a href="https://www.youtube.com/@nxdevtools/videos" target="_blank" rel="noreferrer"><img src="./images/nx-courses-and-videos.svg"
61-
width="100%" alt="Nx - Smart Repos · Fast Builds"></a></p>
61+
width="100%" alt="Nx - Smart Monorepos · Fast Builds"></a></p>
6262

6363
## Want to help?
6464

astro-docs/src/content/docs/getting-started/Tutorials/angular-monorepo-tutorial.mdoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'Building and Testing Angular Apps in Nx'
3-
description: In this tutorial you'll create a frontend-focused workspace with Nx.
3+
description: In this tutorial you'll create a frontend-focused monorepo with Nx.
44
sidebar:
55
label: 'Angular Monorepo'
66
filter: 'type:Guides'

astro-docs/src/content/docs/getting-started/Tutorials/gradle-tutorial.mdoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Root project 'gradle-tutorial'
106106

107107
## Add Nx
108108

109-
Nx is a build system with built in tooling and advanced CI capabilities. It helps you maintain and scale monorepos,
109+
Nx is a monorepo platform with built in tooling and advanced CI capabilities. It helps you maintain and scale monorepos,
110110
both locally and on CI. We will explore the features of Nx in this tutorial by adding it to the Gradle workspace above.
111111

112112
To add Nx, run

astro-docs/src/content/docs/getting-started/Tutorials/react-monorepo-tutorial.mdoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'Building and Testing React Apps in Nx'
33
sidebar:
44
label: 'React Monorepo'
5-
description: In this tutorial you'll create a frontend-focused workspace with Nx.
5+
description: In this tutorial you'll create a frontend-focused monorepo with Nx.
66
filter: 'type:Guides'
77
---
88

astro-docs/src/content/docs/getting-started/intro.mdoc

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: What is Nx?
3-
description: 'Nx is an AI-first build platform that connects everything from your editor to CI Helping you deliver fast, without breaking things.'
3+
description: 'Nx is an AI-first monorepo platform that connects everything from your editor to CI. Helping you deliver fast, without breaking things.'
44
sidebar:
55
order: 1
66
label: Introduction
77
filter: 'type:Features'
88
---
99

10-
Nx is a powerful, open source, technology-agnostic build platform designed to efficiently manage codebases of any scale. From small single projects to large enterprise monorepos, Nx provides the platform to **efficiently get from starting a feature in your editor to a green PR**.
10+
Nx is a powerful, open-source, technology-agnostic **monorepo platform** designed to efficiently manage codebases of any scale. From small workspaces to large enterprise monorepos, Nx provides the tools to **efficiently get from starting a feature in your editor to a green PR**.
1111

1212
As teams and codebases grow, productivity bottlenecks multiply: build times increase, CI becomes flaky, and code sharing becomes complex. **Nx reduces friction across your entire development cycle.**
1313

@@ -17,6 +17,12 @@ As teams and codebases grow, productivity bottlenecks multiply: build times incr
1717

1818
Nx is built in a modular fashion, allowing you to adopt as little or as much as you'd like at any moment in your development lifecycle. You can **start with just the core and add additional capabilities incrementally** as your needs grow and complexity increases.
1919

20+
{% callout type="deepdive" title="Can I add Nx to a single-project repo?" %}
21+
Yes, Nx provides value even for single-project repositories. You get fast task caching, intelligent task orchestration, and access to Nx plugins for your specific technology stack. As your project grows into a monorepo, the foundation is already in place.
22+
23+
Nx can also connect multiple repositories into a synthetic monorepo, letting you orchestrate large changes across all connected repos.
24+
{% /callout %}
25+
2026
At the **foundation is Nx Core**, a Rust-based, technology-agnostic task runner. Nx Core creates a knowledge graph of your workspace, understanding project relationships and dependencies. This enables highly optimized and fast task execution regardless of technology stack. It runs `package.json` scripts in [TypeScript monorepos](/docs/technologies/typescript/introduction) or Gradle tasks in [Java projects](/docs/technologies/java/introduction) or [can be extended](/docs/extending-nx/intro) to meet your project's specific needs.
2127

2228
{% callout type="deepdive" title="What do you mean by \"running NPM scripts\"?" %}
@@ -60,7 +66,7 @@ From there, you can gradually enhance your setup by adding features like [task c
6066
{% /callout %}
6167

6268
Nx Core provides everything you need to get started and works perfectly on its own.
63-
**When you're ready for more, the Nx platform offers additional capabilities you can adopt incrementally**.
69+
**When you're ready for more, the Nx monorepo platform offers additional capabilities you can adopt incrementally**.
6470
Extend your setup with [**Nx Cloud**](/docs/getting-started/nx-cloud) for remote caching, distributed task execution, and [**AI-powered self-healing CI**](/docs/features/ci-features/self-healing-ci) that automatically detects, analyzes, and fixes CI failures.
6571
Integrate [**Nx Console**](/docs/getting-started/editor-setup) with your editor for powerful autocomplete, project graph visualization, CI notifications, and an MCP to [make your AI coding assistant smarter](/docs/features/enhance-ai).
6672
Add [**Nx Plugins**](/docs/technologies) for technology-specific automation and DX improvements, or build custom platform capabilities using [Nx Devkit](/docs/extending-nx/intro).

astro-docs/src/content/docs/getting-started/start-new-project.mdoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Choose a preset that matches your technology stack. This gives you a fully confi
6262

6363
You can also choose **an empty workspace preset** (`--preset=ts`) which sets up the bare minimum configuration for TypeScript and Nx. This allows you to add technologies and features incrementally over time as you need them.
6464

65-
## Option 3: Get the complete Nx platform experience
65+
## Option 3: Get the complete Nx monorepo platform experience
6666

6767
[![Nx Cloud onboarding](../../../assets/getting-started/nx-cloud-starting-screen.avif)](https://cloud.nx.app/get-started?utm_source=nx-docs&utm_medium=nx-cloud-onboarding&utm_campaign=start-new-project)
6868

@@ -74,4 +74,4 @@ This means you benefit from intelligent automation right from day one, without h
7474

7575
As your project grows and scales, you'll have access to additional features like **remote caching** to speed up builds across your team, **distributed task execution with Nx Agents** to parallelize work across multiple machines, and **automatic test splitting** to optimize your CI pipeline performance.
7676

77-
[Get started with the complete Nx platform experience →](https://cloud.nx.app/get-started?utm_source=nx-docs&utm_medium=nx-cloud-onboarding&utm_campaign=start-new-project)
77+
[Get started with the complete Nx monorepo platform experience →](https://cloud.nx.app/get-started?utm_source=nx-docs&utm_medium=nx-cloud-onboarding&utm_campaign=start-new-project)

astro-docs/src/content/docs/guides/Tasks & Caching/self-hosted-caching.mdoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ You can implement your server in any programming language or framework, as long
7777
"openapi": "3.0.0",
7878
"info": {
7979
"title": "Nx custom remote cache specification.",
80-
"description": "Nx is an AI-first build platform that connects everything from your editor to CI. Helping you deliver fast, without breaking things.",
80+
"description": "Nx is an AI-first monorepo platform that connects everything from your editor to CI. Helping you deliver fast, without breaking things.",
8181
"version": "1.0.0"
8282
},
8383
"paths": {

astro-docs/src/content/docs/quickstart.mdoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Quickstart with Nx
3-
description: Get up and running with Nx in minutes - install Nx, set up your editor, configure AI assistance, and choose your development path.
3+
description: Get up and running with the Nx monorepo platform in minutes - install Nx, set up your editor, configure AI assistance, and choose your development path.
44
tableOfContents: false
55
filter: 'type:Guides'
66
---

astro-docs/src/content/docs/technologies/typescript/Guides/js-and-ts.mdoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar:
66
filter: 'type:Guides'
77
---
88

9-
Nx is a general-purpose build system and a general-purpose CLI. It works with JavaScript, TypeScript, Java, C#, Go, etc.. The core plugins Nx comes with do work best with JavaScript or TypeScript.
9+
Nx is a general-purpose monorepo platform and CLI. It works with JavaScript, TypeScript, Java, C#, Go, etc.. The core plugins Nx comes with do work best with JavaScript or TypeScript.
1010

1111
TypeScript is a great choice for many teams, but not for everyone. If you want to use Nx with JavaScript, simply pass `--js` to all generate commands, as follows:
1212

astro-docs/src/pages/llms-full.txt.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ export const GET: APIRoute = async ({ site }) => {
139139
'',
140140
'> Complete Nx documentation compiled into a single file for LLM consumption.',
141141
'',
142-
'Nx is a powerful, open source, technology-agnostic build platform designed to efficiently manage codebases of any scale. From small single projects to large enterprise monorepos, Nx provides intelligent task execution, caching, and CI optimization.',
142+
'Nx is a powerful, open-source, technology-agnostic monorepo platform designed to efficiently manage codebases of any scale. From small workspaces to large enterprise monorepos, Nx provides intelligent task execution, caching, and CI optimization.',
143143
'',
144144
`This file was generated from ${entries.length} documentation pages.`,
145145
`Individual pages are available at: ${siteUrl}/docs/{slug}.md`,

0 commit comments

Comments
 (0)