Skip to content

Commit

Permalink
docs(core): nx command related docs (#28891)
Browse files Browse the repository at this point in the history
Adds related documents to Nx commands API reference pages
  • Loading branch information
isaacplmann authored Nov 13, 2024
1 parent 7f4fc50 commit 0983ba5
Show file tree
Hide file tree
Showing 7 changed files with 247 additions and 55 deletions.
6 changes: 3 additions & 3 deletions docs/generated/manifests/ci.json
Original file line number Diff line number Diff line change
Expand Up @@ -600,7 +600,7 @@
"itemList": [],
"isExternal": false,
"path": "/ci/recipes/security/personal-access-tokens",
"tags": []
"tags": ["login"]
},
{
"id": "encryption",
Expand Down Expand Up @@ -1074,7 +1074,7 @@
"itemList": [],
"isExternal": false,
"path": "/ci/recipes/security/personal-access-tokens",
"tags": []
"tags": ["login"]
},
{
"id": "encryption",
Expand Down Expand Up @@ -1123,7 +1123,7 @@
"itemList": [],
"isExternal": false,
"path": "/ci/recipes/security/personal-access-tokens",
"tags": []
"tags": ["login"]
},
"/ci/recipes/security/encryption": {
"id": "encryption",
Expand Down
4 changes: 2 additions & 2 deletions docs/generated/manifests/extending-nx.json
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@
"itemList": [],
"isExternal": false,
"path": "/extending-nx/recipes/create-sync-generator",
"tags": ["generate-code"]
"tags": ["generate-code", "sync"]
},
{
"id": "migration-generators",
Expand Down Expand Up @@ -308,7 +308,7 @@
"itemList": [],
"isExternal": false,
"path": "/extending-nx/recipes/create-sync-generator",
"tags": ["generate-code"]
"tags": ["generate-code", "sync"]
},
"/extending-nx/recipes/migration-generators": {
"id": "migration-generators",
Expand Down
22 changes: 11 additions & 11 deletions docs/generated/manifests/nx-api.json
Original file line number Diff line number Diff line change
Expand Up @@ -1748,7 +1748,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/create-nx-workspace",
"tags": [],
"tags": ["installation"],
"originalFilePath": "generated/cli/create-nx-workspace"
},
"/nx-api/nx/documents/init": {
Expand All @@ -1759,7 +1759,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/init",
"tags": [],
"tags": ["init"],
"originalFilePath": "generated/cli/init"
},
"/nx-api/nx/documents/generate": {
Expand Down Expand Up @@ -1792,7 +1792,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/daemon",
"tags": [],
"tags": ["daemon"],
"originalFilePath": "generated/cli/daemon"
},
"/nx-api/nx/documents/dep-graph": {
Expand Down Expand Up @@ -1924,7 +1924,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/sync",
"tags": [],
"tags": ["sync"],
"originalFilePath": "generated/cli/sync"
},
"/nx-api/nx/documents/sync-check": {
Expand All @@ -1935,7 +1935,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/sync-check",
"tags": [],
"tags": ["sync"],
"originalFilePath": "generated/cli/sync-check"
},
"/nx-api/nx/documents/import": {
Expand All @@ -1946,7 +1946,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/import",
"tags": [],
"tags": ["import"],
"originalFilePath": "generated/cli/import"
},
"/nx-api/nx/documents/exec": {
Expand All @@ -1957,7 +1957,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/exec",
"tags": [],
"tags": ["exec"],
"originalFilePath": "generated/cli/exec"
},
"/nx-api/nx/documents/watch": {
Expand All @@ -1979,7 +1979,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/show",
"tags": [],
"tags": ["explore-graph"],
"originalFilePath": "generated/cli/show"
},
"/nx-api/nx/documents/view-logs": {
Expand Down Expand Up @@ -2012,7 +2012,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/add",
"tags": [],
"tags": ["add"],
"originalFilePath": "generated/cli/add"
},
"/nx-api/nx/documents/login": {
Expand All @@ -2023,7 +2023,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/login",
"tags": [],
"tags": ["login"],
"originalFilePath": "generated/cli/login"
},
"/nx-api/nx/documents/logout": {
Expand All @@ -2034,7 +2034,7 @@
"itemList": [],
"isExternal": false,
"path": "/nx-api/nx/documents/logout",
"tags": [],
"tags": ["login"],
"originalFilePath": "generated/cli/logout"
}
},
Expand Down
55 changes: 30 additions & 25 deletions docs/generated/manifests/nx.json
Original file line number Diff line number Diff line change
Expand Up @@ -791,7 +791,12 @@
"itemList": [],
"isExternal": false,
"path": "/concepts/nx-plugins",
"tags": ["generate-code", "create-your-own-plugin", "inferred-tasks"]
"tags": [
"add",
"generate-code",
"create-your-own-plugin",
"inferred-tasks"
]
},
{
"id": "inferred-tasks",
Expand Down Expand Up @@ -835,7 +840,7 @@
"itemList": [],
"isExternal": false,
"path": "/concepts/nx-daemon",
"tags": []
"tags": ["daemon"]
},
{
"id": "sync-generators",
Expand All @@ -846,7 +851,7 @@
"itemList": [],
"isExternal": false,
"path": "/concepts/sync-generators",
"tags": []
"tags": ["sync"]
},
{
"id": "turbo-and-nx",
Expand Down Expand Up @@ -1073,7 +1078,7 @@
"itemList": [],
"isExternal": false,
"path": "/concepts/nx-plugins",
"tags": ["generate-code", "create-your-own-plugin", "inferred-tasks"]
"tags": ["add", "generate-code", "create-your-own-plugin", "inferred-tasks"]
},
"/concepts/inferred-tasks": {
"id": "inferred-tasks",
Expand Down Expand Up @@ -1117,7 +1122,7 @@
"itemList": [],
"isExternal": false,
"path": "/concepts/nx-daemon",
"tags": []
"tags": ["daemon"]
},
"/concepts/sync-generators": {
"id": "sync-generators",
Expand All @@ -1128,7 +1133,7 @@
"itemList": [],
"isExternal": false,
"path": "/concepts/sync-generators",
"tags": []
"tags": ["sync"]
},
"/concepts/turbo-and-nx": {
"id": "turbo-and-nx",
Expand Down Expand Up @@ -1563,7 +1568,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/running-tasks/root-level-scripts",
"tags": ["run-tasks"]
"tags": ["run-tasks", "exec"]
},
{
"id": "workspace-watching",
Expand Down Expand Up @@ -1641,7 +1646,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/adopting-nx/adding-to-monorepo",
"tags": []
"tags": ["init"]
},
{
"id": "from-turborepo",
Expand All @@ -1663,7 +1668,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/adopting-nx/adding-to-existing-project",
"tags": []
"tags": ["init"]
},
{
"id": "import-project",
Expand All @@ -1674,7 +1679,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/adopting-nx/import-project",
"tags": []
"tags": ["import"]
},
{
"id": "preserving-git-histories",
Expand Down Expand Up @@ -2104,7 +2109,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/angular/migration/angular",
"tags": []
"tags": ["init"]
},
{
"id": "angular-multiple",
Expand Down Expand Up @@ -2679,7 +2684,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/tips-n-tricks/keep-nx-versions-in-sync",
"tags": ["automate-updating-dependencies"]
"tags": ["automate-updating-dependencies", "add"]
},
{
"id": "define-environment-variables",
Expand Down Expand Up @@ -2939,7 +2944,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/running-tasks/root-level-scripts",
"tags": ["run-tasks"]
"tags": ["run-tasks", "exec"]
},
{
"id": "workspace-watching",
Expand Down Expand Up @@ -3076,7 +3081,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/running-tasks/root-level-scripts",
"tags": ["run-tasks"]
"tags": ["run-tasks", "exec"]
},
"/recipes/running-tasks/workspace-watching": {
"id": "workspace-watching",
Expand Down Expand Up @@ -3149,7 +3154,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/adopting-nx/adding-to-monorepo",
"tags": []
"tags": ["init"]
},
{
"id": "from-turborepo",
Expand All @@ -3171,7 +3176,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/adopting-nx/adding-to-existing-project",
"tags": []
"tags": ["init"]
},
{
"id": "import-project",
Expand All @@ -3182,7 +3187,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/adopting-nx/import-project",
"tags": []
"tags": ["import"]
},
{
"id": "preserving-git-histories",
Expand Down Expand Up @@ -3220,7 +3225,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/adopting-nx/adding-to-monorepo",
"tags": []
"tags": ["init"]
},
"/recipes/adopting-nx/from-turborepo": {
"id": "from-turborepo",
Expand All @@ -3242,7 +3247,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/adopting-nx/adding-to-existing-project",
"tags": []
"tags": ["init"]
},
"/recipes/adopting-nx/import-project": {
"id": "import-project",
Expand All @@ -3253,7 +3258,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/adopting-nx/import-project",
"tags": []
"tags": ["import"]
},
"/recipes/adopting-nx/preserving-git-histories": {
"id": "preserving-git-histories",
Expand Down Expand Up @@ -4008,7 +4013,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/angular/migration/angular",
"tags": []
"tags": ["init"]
},
{
"id": "angular-multiple",
Expand Down Expand Up @@ -4102,7 +4107,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/angular/migration/angular",
"tags": []
"tags": ["init"]
},
{
"id": "angular-multiple",
Expand All @@ -4129,7 +4134,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/angular/migration/angular",
"tags": []
"tags": ["init"]
},
"/recipes/angular/migration/angular-multiple": {
"id": "angular-multiple",
Expand Down Expand Up @@ -5024,7 +5029,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/tips-n-tricks/keep-nx-versions-in-sync",
"tags": ["automate-updating-dependencies"]
"tags": ["automate-updating-dependencies", "add"]
},
{
"id": "define-environment-variables",
Expand Down Expand Up @@ -5205,7 +5210,7 @@
"itemList": [],
"isExternal": false,
"path": "/recipes/tips-n-tricks/keep-nx-versions-in-sync",
"tags": ["automate-updating-dependencies"]
"tags": ["automate-updating-dependencies", "add"]
},
"/recipes/tips-n-tricks/define-environment-variables": {
"id": "define-environment-variables",
Expand Down
Loading

0 comments on commit 0983ba5

Please sign in to comment.