angular-cli/docs/README.md
Hans a6f80e4fe7 Various QoL with TSLint and Docs (#12655)
* docs: add README files to all root folders

Except benchmark and tools.

* refactor: move rules/ directory to etc/

And fix a linting error that was found while updating tslint usage

* ci: lint errors out if TSLint shows a warning

This is not a warning from the code itself, but from TSLint. For example,
if a rule was missing, TSLint will just ignore the rule, show something on
STDOUT and not fail.

This fixes CI where local rules were missing for unknown reasons. It will
now fail CI when that happens, which is the correct behaviour.
2018-10-23 11:59:16 -07:00

846 B

/docs Folder

This folder is used for all documentation. It contains a number of subfolders with short descriptions here.

/docs/design

Design documents on GitHub, in Markdown format. The number of design documents available is limited.

/docs/documentation

THIS FOLDER IS DEPRECATED AND SHOULD NOT BE UPDATED ANYMORE. Documentation is now available on angular.io and can be updated on the main angular/angular repo.

Markdown files used to publish to the GitHub Wiki.

/docs/process

Description of various caretaker and workflow processes.

/docs/specifications

Specifications for support of Angular CLI features. These are meant to be read directly on GitHub by developers of libraries who want to integrate with the Angular CLI.