Doc: src/app/shared add documentation comments to index.ts

[arlowhite]

Versions.

angular-cli: 1.0.0-beta.16
node: 6.3.1
os: linux x64

Repro steps.

Create project with ng new

Needed Documentation

angular-cli projects have a shared directory with this file src/app/shared/index.ts

I haven't read through all of the new NgModule docs on angular.io, so I wasn't sure what this was for.

Please add a comment to this file that links to angular.io:
https://angular.io/docs/ts/latest/guide/ngmodule.html#!#shared-module

Also, maybe give a few example ng commands. (angular-cli/tests/acceptance has a couple examples)
ng generate module shared/my-module
ng generate class shared/my-class

Questions

Should the developer modify shared/index.ts?
Do they need to add export * from './my-module' as in src/app/index.ts?

Also, I noticed angular-cli/tests/e2e/tests/build/ts-paths.ts modifies tsconfig.json so that you can import '@shared/my-module;
Should this be added to tsconfig.json by default or should it be documented somewhere?

---

shared/index.ts

// Directory for Shared Modules
// https://angular.io/docs/ts/latest/guide/ngmodule.html#!#shared-module
//
// You can generate files here with ng, for example:
//  ng generate module shared/my-module
//  ng generate class shared/my-class

[filipesilva]

@Brocco what do you think about adding comment docs to shared/?

Regarding @shared/my-module, I don't think we should add documentation around it since it's a TypeScript feature. We simply added support for it.

[Brocco]

The idea of shared/index.ts is a hold over from supporting barrels, and can be removed from newly generated projects. I will submit a PR.

[angular-automatic-lock-bot]

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}