Skip to content

Commit

Permalink
docs(core): add recipe on console & project details view integration (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
MaxKless authored Feb 4, 2024
1 parent 9ccdb70 commit cc282b2
Show file tree
Hide file tree
Showing 7 changed files with 83 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/generated/manifests/menus.json
Original file line number Diff line number Diff line change
Expand Up @@ -2260,6 +2260,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "Project Details View",
"path": "/recipes/nx-console/console-project-details",
"id": "console-project-details",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Generate Command",
"path": "/recipes/nx-console/console-generate-command",
Expand Down Expand Up @@ -4045,6 +4053,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "Project Details View",
"path": "/recipes/nx-console/console-project-details",
"id": "console-project-details",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Generate Command",
"path": "/recipes/nx-console/console-generate-command",
Expand Down Expand Up @@ -4104,6 +4120,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "Project Details View",
"path": "/recipes/nx-console/console-project-details",
"id": "console-project-details",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Generate Command",
"path": "/recipes/nx-console/console-generate-command",
Expand Down
33 changes: 33 additions & 0 deletions docs/generated/manifests/nx.json
Original file line number Diff line number Diff line change
Expand Up @@ -3090,6 +3090,17 @@
"path": "/recipes/nx-console/console-telemetry",
"tags": ["integrate-with-editors"]
},
{
"id": "console-project-details",
"name": "Project Details View",
"description": "",
"mediaImage": "",
"file": "shared/recipes/console-project-details",
"itemList": [],
"isExternal": false,
"path": "/recipes/nx-console/console-project-details",
"tags": ["integrate-with-editors"]
},
{
"id": "console-generate-command",
"name": "Generate Command",
Expand Down Expand Up @@ -5537,6 +5548,17 @@
"path": "/recipes/nx-console/console-telemetry",
"tags": ["integrate-with-editors"]
},
{
"id": "console-project-details",
"name": "Project Details View",
"description": "",
"mediaImage": "",
"file": "shared/recipes/console-project-details",
"itemList": [],
"isExternal": false,
"path": "/recipes/nx-console/console-project-details",
"tags": ["integrate-with-editors"]
},
{
"id": "console-generate-command",
"name": "Generate Command",
Expand Down Expand Up @@ -5619,6 +5641,17 @@
"path": "/recipes/nx-console/console-telemetry",
"tags": ["integrate-with-editors"]
},
"/recipes/nx-console/console-project-details": {
"id": "console-project-details",
"name": "Project Details View",
"description": "",
"mediaImage": "",
"file": "shared/recipes/console-project-details",
"itemList": [],
"isExternal": false,
"path": "/recipes/nx-console/console-project-details",
"tags": ["integrate-with-editors"]
},
"/recipes/nx-console/console-generate-command": {
"id": "console-generate-command",
"name": "Generate Command",
Expand Down
7 changes: 7 additions & 0 deletions docs/generated/manifests/tags.json
Original file line number Diff line number Diff line change
Expand Up @@ -453,6 +453,13 @@
"name": "Telemetry",
"path": "/recipes/nx-console/console-telemetry"
},
{
"description": "",
"file": "shared/recipes/console-project-details",
"id": "console-project-details",
"name": "Project Details View",
"path": "/recipes/nx-console/console-project-details"
},
{
"description": "",
"file": "shared/recipes/console-generate-command",
Expand Down
6 changes: 6 additions & 0 deletions docs/map.json
Original file line number Diff line number Diff line change
Expand Up @@ -1088,6 +1088,12 @@
"tags": ["integrate-with-editors"],
"file": "shared/recipes/console-telemetry"
},
{
"name": "Project Details View",
"id": "console-project-details",
"tags": ["integrate-with-editors"],
"file": "shared/recipes/console-project-details"
},
{
"name": "Generate Command",
"id": "console-generate-command",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions docs/shared/recipes/console-project-details.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Nx Console Project Details View

Nx Console provides seamless integration with the [Project Details View](features/explore-graph#explore-projects-in-your-workspace).
You can learn more about your project, run tasks or navigate the task graph with just a few clicks!

![console-pdv-example.png](/shared/images/nx-console/console-pdv-example.png)

You can access the integrated Project Details View in multiple ways:

- By clicking on the Preview icon to the top right of your `project.json`, `package.json` or any file that modifies targets (for example `jest.config.ts` or `cypress.config.ts`)
- By using the codelenses in any of these files
- By running the `Nx: Open Project Details to Side` action while any file in a project is open
1 change: 1 addition & 0 deletions docs/shared/reference/sitemap.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@
- [Profiling Build Performance](/recipes/troubleshooting/performance-profiling)
- [Nx Console](/recipes/nx-console)
- [Telemetry](/recipes/nx-console/console-telemetry)
- [Project Details View](/recipes/nx-console/console-project-details)
- [Generate Command](/recipes/nx-console/console-generate-command)
- [Run Command](/recipes/nx-console/console-run-command)
- [Add Dependency Command](/recipes/nx-console/console-add-dependency-command)
Expand Down

0 comments on commit cc282b2

Please sign in to comment.