[Proposal] Create wiki pages for documentation

Type of Issue

[ ] Bug Report
[x] Feature Request

Description

With every release more features are added, and its kinda hard to keep track how to do something from the readme and the other md docs as they are growing longer and longer.

I believe that a wiki space should be created with organized pages.

Angular CLI Team have some good wiki pages/stores https://github.com/angular/angular-cli/wiki

[dherges]

Hi @georgiee @alan-agius4 sound sperfectly reasonable. I don’t know yet how this project will continue, whether it is standalone or in a github org or as part of the angular devkit.

If you like to add documentation, wdyt about adding markdown files to the docs folder of this repo?

[georgiee]

Yes I totally support this as I keep seeing me digging through the ng-package sources 👍 I would like to document the whole API surface but also some good examples - as they are already present in the integration folder in the sources.

Instead of just demanding, such a piece of documentation is a perfect thing we could easily compile and provide @dherges as a draft to continue working on. Should we start outlining here what to would be nice to see in such a documentation?

I see something like this:

• Configuration/API
  • Override tsconfig
  • Submodules and intra-package dependencies
• Common Problems
  • Examples of Barrel file issues and how to recognize them
  • Submodules need a specific version of Typescript
  • Issues with local linking and how --follow-symlink helps
• Best Practice
  • Manually copy over readme files
  • Advantages of Submodules or when you really want them (peer dependencies)
• Examples (Based on the files in ./integration )
• Cheat sheet (some compact tables)