Skip to content

Commit 4493d88

Browse files
committed
docs: start rewriting docs
1 parent 0b884c5 commit 4493d88

File tree

4 files changed

+17
-11
lines changed

4 files changed

+17
-11
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Resources in CSS, such as images and fonts, are automatically written and fingerprinted at the root
2+
of the output folder. If a resource is less than 10kb, it is also included inline.
3+
4+
Uses the Webpack build tool, with environment and build options specified in the CLI configuration
5+
file.

packages/angular/cli/commands/build.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"$schema": "http://json-schema.org/schema",
33
"$id": "ng-cli://commands/build.json",
4-
"description": "Builds your app and places it into the output path (dist/ by default).",
5-
"$longDescription": "",
4+
"description": "Compiles an Angular app into an output directory named dist/ at the given output path. Must be executed from within a workspace directory.",
5+
"$longDescription": "./build-long.md",
66

77
"$aliases": [ "b" ],
88
"$scope": "in",

packages/angular/cli/commands/definitions.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,21 @@
77
"properties": {
88
"project": {
99
"type": "string",
10-
"description": "The name of the project to build.",
10+
"description": "The name of the project to build. Can be an app or a library.",
1111
"$default": {
1212
"$source": "argv",
1313
"index": 0
1414
}
1515
},
1616
"configuration": {
17-
"description": "Specify the configuration to use.",
17+
"description": "A named configuration environment, as specified in the `configurations` section of `angular.json`.",
1818
"type": "string",
1919
"aliases": [
2020
"c"
2121
]
2222
},
2323
"prod": {
24-
"description": "Flag to set configuration to 'production'.",
24+
"description": "When true, sets the build configuration to the production environment.\nAll builds make use of bundling and limited tree-shaking, A production build also runs limited dead code elimination using UglifyJS.",
2525
"type": "boolean"
2626
}
2727
}

packages/angular_devkit/build_angular/src/browser/schema.json

+7-6
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,16 @@
1212
},
1313
"main": {
1414
"type": "string",
15-
"description": "The name of the main entry-point file."
15+
"description": "The full path for the main entry point to the app, relative to the current workspace.",
16+
"$valueDescription": "fileName"
1617
},
1718
"polyfills": {
1819
"type": "string",
19-
"description": "The name of the polyfills file."
20+
"description": "The full path for the polyfills file, relative to the current workspace."
2021
},
2122
"tsConfig": {
2223
"type": "string",
23-
"description": "The name of the TypeScript configuration file."
24+
"description": "The full path for the TypeScript configuration file, relative to the current workspace."
2425
},
2526
"scripts": {
2627
"description": "Global scripts to be included in the build.",
@@ -55,7 +56,7 @@
5556
},
5657
"optimization": {
5758
"type": "boolean",
58-
"description": "Enables optimization of the build output.",
59+
"description": "When true, uses optimization for the app build.",
5960
"default": false
6061
},
6162
"fileReplacements": {
@@ -68,7 +69,7 @@
6869
},
6970
"outputPath": {
7071
"type": "string",
71-
"description": "Path where output will be placed."
72+
"description": "The full path for the new output directory, relative to the current workspace.\n\nBy default, writes output to a folder named dist/ in the current project."
7273
},
7374
"aot": {
7475
"type": "boolean",
@@ -408,4 +409,4 @@
408409
]
409410
}
410411
}
411-
}
412+
}

0 commit comments

Comments
 (0)