Skip to content

Commit 8369e69

Browse files
docs(astro-docs): reorganize Learn Nx sidebar structure
- Simplify getting started flow: Introduction → Start New → Add Existing → Local Dev - Merge editor-setup and ai-setup into single local-development page - Add global install preamble to start-new-project and start-with-existing-project - Move nx-cloud intro to guides/Nx Cloud section - Move install-non-javascript to reference section - Move update-global-installation to troubleshooting section - Curate Concepts section to only include core concepts: - Mental Model, How Caching Works, Task Pipelines, Inferred Tasks, Nx Plugins - Update all internal links to reflect new page locations URL changes requiring redirects: - /docs/getting-started/installation → /docs/getting-started/start-new-project - /docs/getting-started/editor-setup → /docs/getting-started/local-development - /docs/getting-started/ai-setup → /docs/getting-started/local-development - /docs/getting-started/nx-cloud → /docs/guides/nx-cloud/intro - /docs/guides/installation/install-non-javascript → /docs/reference/install-non-javascript - /docs/guides/installation/update-global-installation → /docs/troubleshooting/update-global-installation
1 parent 432c857 commit 8369e69

35 files changed

+235
-223
lines changed

astro-docs/URL_REDIRECTS.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# URL Redirects Tracking
2+
3+
This file tracks URL changes that need redirects configured in the deployment platform (Netlify).
4+
5+
## Learn Nx Reorganization (DOC-365)
6+
7+
Date: 2024-12-19
8+
9+
### Redirects Required
10+
11+
| Old URL | New URL | Status |
12+
| ------------------------------------------------------ | -------------------------------------------------- | ------- |
13+
| `/docs/getting-started/installation` | `/docs/getting-started/start-new-project` | Pending |
14+
| `/docs/getting-started/editor-setup` | `/docs/getting-started/local-development` | Pending |
15+
| `/docs/getting-started/ai-setup` | `/docs/getting-started/local-development` | Pending |
16+
| `/docs/getting-started/nx-cloud` | `/docs/guides/nx-cloud/intro` | Pending |
17+
| `/docs/guides/installation/install-non-javascript` | `/docs/reference/install-non-javascript` | Pending |
18+
| `/docs/guides/installation/update-global-installation` | `/docs/troubleshooting/update-global-installation` | Pending |
19+
20+
### Notes
21+
22+
- All redirects should be 301 (permanent) redirects
23+
- Configure in `netlify.toml` or Netlify dashboard
24+
- Test redirects after deployment to ensure they work correctly
25+
26+
### Netlify Configuration Example
27+
28+
```toml
29+
# Add to netlify.toml
30+
31+
[[redirects]]
32+
from = "/docs/getting-started/installation"
33+
to = "/docs/getting-started/start-new-project"
34+
status = 301
35+
36+
[[redirects]]
37+
from = "/docs/getting-started/editor-setup"
38+
to = "/docs/getting-started/local-development"
39+
status = 301
40+
41+
[[redirects]]
42+
from = "/docs/getting-started/ai-setup"
43+
to = "/docs/getting-started/local-development"
44+
status = 301
45+
46+
[[redirects]]
47+
from = "/docs/getting-started/nx-cloud"
48+
to = "/docs/guides/nx-cloud/intro"
49+
status = 301
50+
51+
[[redirects]]
52+
from = "/docs/guides/installation/install-non-javascript"
53+
to = "/docs/reference/install-non-javascript"
54+
status = 301
55+
56+
[[redirects]]
57+
from = "/docs/guides/installation/update-global-installation"
58+
to = "/docs/troubleshooting/update-global-installation"
59+
status = 301
60+
```

astro-docs/sidebar.mts

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,7 @@ export const sidebar: StarlightUserConfig['sidebar'] = [
99
label: 'Learn Nx',
1010
collapsed: false,
1111
items: [
12-
// Getting Started - flattened
13-
{ label: 'Why Nx?', link: 'getting-started/intro' },
14-
{ label: 'Installation', link: 'getting-started/installation' },
12+
{ label: 'Introduction', link: 'getting-started/intro' },
1513
{
1614
label: 'Start a New Project',
1715
link: 'getting-started/start-new-project',
@@ -20,16 +18,9 @@ export const sidebar: StarlightUserConfig['sidebar'] = [
2018
label: 'Add to Existing Project',
2119
link: 'getting-started/start-with-existing-project',
2220
},
23-
{ label: 'Editor Setup', link: 'getting-started/editor-setup' },
24-
{ label: 'AI Setup', link: 'getting-started/ai-setup' },
25-
{ label: 'Nx Cloud Intro', link: 'getting-started/nx-cloud' },
2621
{
27-
label: 'Install in Non-JS Repo',
28-
link: 'guides/installation/install-non-javascript',
29-
},
30-
{
31-
label: 'Update Global Installation',
32-
link: 'guides/installation/update-global-installation',
22+
label: 'Local Development',
23+
link: 'getting-started/local-development',
3324
},
3425
{
3526
label: 'Tutorials',
@@ -40,9 +31,18 @@ export const sidebar: StarlightUserConfig['sidebar'] = [
4031
},
4132
},
4233
{
43-
label: 'Core Concepts',
34+
label: 'Concepts',
4435
collapsed: true,
45-
autogenerate: { directory: 'concepts', collapsed: true },
36+
items: [
37+
{ label: 'Mental Model', link: 'concepts/mental-model' },
38+
{ label: 'How Caching Works', link: 'concepts/how-caching-works' },
39+
{
40+
label: 'Task Pipelines',
41+
link: 'concepts/task-pipeline-configuration',
42+
},
43+
{ label: 'Inferred Tasks', link: 'concepts/inferred-tasks' },
44+
{ label: 'Nx Plugins', link: 'concepts/nx-plugins' },
45+
],
4646
},
4747
],
4848
},

astro-docs/src/content/docs/extending-nx/local-executors.mdoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Learn how to create, run, and customize local executors in your Nx
44
filter: 'type:Guides'
55
---
66

7-
Creating Executors for your workspace standardizes scripts that are run during your development/building/deploying tasks in order to provide guidance in the terminal with `--help` and when invoking with [Nx Console](/docs/getting-started/editor-setup)
7+
Creating Executors for your workspace standardizes scripts that are run during your development/building/deploying tasks in order to provide guidance in the terminal with `--help` and when invoking with [Nx Console](/docs/getting-started/local-development)
88

99
This guide shows you how to create, run, and customize executors within your Nx workspace. The examples use the trivial use-case of an `echo` command.
1010

astro-docs/src/content/docs/extending-nx/organization-specific-plugin.mdoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ export interface LibraryGeneratorSchema {
133133
The `schema.d.ts` file is used for type checking inside the implementation file. It should match the properties in `schema.json`.
134134
{% /aside %}
135135

136-
The schema files not only provide structure to the CLI, but also allow [Nx Console](/docs/getting-started/editor-setup) to show an accurate UI for the generator.
136+
The schema files not only provide structure to the CLI, but also allow [Nx Console](/docs/getting-started/local-development) to show an accurate UI for the generator.
137137

138138
![Nx Console UI for the library generator](../../../assets/nx-console/generator-options-ui.png)
139139

astro-docs/src/content/docs/features/CI Features/self-healing-ci.mdoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ You will see the notification about an available fix from Nx Cloud directly in y
314314

315315
{% tabitem label="In your editor" %}
316316

317-
If you have [Nx Console](/docs/getting-started/editor-setup) installed, you'll get a notification directly in your editor:
317+
If you have [Nx Console](/docs/getting-started/local-development) installed, you'll get a notification directly in your editor:
318318

319319
![Notification in your editor about an AI fix](../../../../assets/features/notification-self-healing-ci.avif)
320320

@@ -356,7 +356,7 @@ Review the Git diff directly in the comment and click "Apply fix" or "Reject fix
356356

357357
{% tabitem label="In your editor" %}
358358

359-
With [Nx Console](/docs/getting-started/editor-setup) installed, open the dedicated CI view which will show you the fix details as well as the buttons to apply, apply locally or reject the fix.
359+
With [Nx Console](/docs/getting-started/local-development) installed, open the dedicated CI view which will show you the fix details as well as the buttons to apply, apply locally or reject the fix.
360360

361361
![Apply the fix directly from within Nx Console](../../../../assets/features/self-healing-apply-nx-console.avif)
362362

astro-docs/src/content/docs/features/automate-updating-dependencies.mdoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ npx nx@latest migrate latest
2525
```
2626

2727
{% aside type="note" title="Visual migration tool from Nx Console" %}
28-
Want a more visual and guided way to migrate? Check out the [Migrate UI](/docs/guides/nx-console/console-migrate-ui) that comes with the [Nx Console extension](/docs/getting-started/editor-setup).
28+
Want a more visual and guided way to migrate? Check out the [Migrate UI](/docs/guides/nx-console/console-migrate-ui) that comes with the [Nx Console extension](/docs/getting-started/local-development).
2929
{% /aside %}
3030

3131
## How Does It Work?

astro-docs/src/content/docs/features/cache-task-results.mdoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ To view the task settings that have been automatically configured by a plugin, u
171171
nx show project <project-name> --web
172172
```
173173

174-
Alternatively, you can view these directly in your editor by installing [Nx Console](/docs/getting-started/editor-setup).
174+
Alternatively, you can view these directly in your editor by installing [Nx Console](/docs/getting-started/local-development).
175175

176176
Learn more details about [Nx plugins](/docs/concepts/nx-plugins) and [inferred tasks](/docs/concepts/inferred-tasks).
177177

astro-docs/src/content/docs/features/enhance-AI.mdoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The goal is to transform your AI assistant from a generic code helper into an ar
2222

2323
## How Nx MCP Enhances Your LLM
2424

25-
The [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) is an open standard that enables AI models to interact with your development environment through a standardized interface. Nx implements an MCP server via the [Nx Console](/docs/getting-started/editor-setup) that exposes workspace metadata to compatible AI assistants like GitHub Copilot, Claude, and others.
25+
The [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) is an open standard that enables AI models to interact with your development environment through a standardized interface. Nx implements an MCP server via the [Nx Console](/docs/getting-started/local-development) that exposes workspace metadata to compatible AI assistants like GitHub Copilot, Claude, and others.
2626

2727
With the Nx MCP server, your AI assistant gains a "map" of your entire system being able to go from just reasoning at the file level to seeing the higher-level picture. This allows the LLM to move between different abstraction levels - from high-level architecture down to specific implementation details:
2828

@@ -44,7 +44,7 @@ This configures Nx Console which automatically configures and serves the Nx MCP
4444

4545
For VS Code, Cursor, and JetBrains IDE users:
4646

47-
1. Install [Nx Console](/docs/getting-started/editor-setup) from the marketplace
47+
1. Install [Nx Console](/docs/getting-started/local-development) from the marketplace
4848
2. You'll receive a notification to "Improve Copilot/AI agent with Nx-specific context"
4949
3. Click "Yes" to configure the MCP server
5050

astro-docs/src/content/docs/features/explore-graph.mdoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This guide will teach you to use this tool to explore projects, the project grap
2525
Projects in Nx are the different parts of the monorepo which can have tasks run for them.
2626

2727
The best way to see what projects are in your workspace is to view the [project graph](#explore-the-project-graph) which will be covered in the next section.
28-
Another way is to look at the **Projects** pane in [Nx Console](/docs/getting-started/editor-setup) or run `nx show projects` to show a list of projects in your terminal.
28+
Another way is to look at the **Projects** pane in [Nx Console](/docs/getting-started/local-development) or run `nx show projects` to show a list of projects in your terminal.
2929

3030
You can see more details about a specific project in Nx Console or by running `nx show project <project-name> --web`. Both methods will show something like the example below:
3131

@@ -280,7 +280,7 @@ It always stays up to date without having to actively maintain a document as it
280280

281281
### Launching the Project Graph
282282

283-
To launch the project graph visualization for your workspace, use [Nx Console](/docs/getting-started/editor-setup) or run:
283+
To launch the project graph visualization for your workspace, use [Nx Console](/docs/getting-started/local-development) or run:
284284

285285
```shell
286286
npx nx graph

astro-docs/src/content/docs/features/generate-code.mdoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ nx list @nx/react
4040

4141
### Use Nx Console
4242

43-
If you prefer a visual interface, then [Nx Console](/docs/getting-started/editor-setup) is an excellent alternative. It provides a way to visually find and run generators:
43+
If you prefer a visual interface, then [Nx Console](/docs/getting-started/local-development) is an excellent alternative. It provides a way to visually find and run generators:
4444

4545
![Using Nx Console to run generators](../../../assets/nx-console/nx-console-gen-code.avif)
4646

47-
Nx Console is an IDE extension that can be [installed here](/docs/getting-started/editor-setup).
47+
Nx Console is an IDE extension that can be [installed here](/docs/getting-started/local-development).
4848

4949
## Build Your Own Generator
5050

0 commit comments

Comments
 (0)