documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Documentation doesn't reflect CLI capabilities

Open dagdagdag83 opened this issue 8 years ago • 2 comments

The vast majority of the documentation must have been written when the CLI either didn't exist, or wasn't very advanced.

There are very few mentions of "au install " and "au generate element/component".

Most importantly perhaps is the consistent use of jspm/npm or other ways to install packages, when arguably "au install" should be the way of the future.

Se for instance http://aurelia.io/hub.html#/doc/article/aurelia/validation/latest/validation-basics/1 & http://aurelia.io/hub.html#/doc/article/aurelia/framework/latest/the-aurelia-cli/10

Another example is http://aurelia.io/hub.html#/doc/article/aurelia/validation/latest/validation-basics/1 - where despite saying the instructions are specifically for "Aurelia CLI" it shows the instruction for npm install.

I am sure there are more examples. Simply put the documentation needs to be updated for the new, and to my understanding, preferred way to install packages.

dagdagdag83 avatar May 26 '17 08:05 dagdagdag83

The au install command is pretty recent. We definitely need to update our docs to show this and differentiate between different solutions.

EisenbergEffect avatar May 31 '17 03:05 EisenbergEffect

The documentation also does not name "component" for "au generate ". That´s unfortunate, because in contrast to "au generate element" generate component asks in what subfolder the component should be placed.

Ah, now i see @the--dud already mentioned that, sorry.

Alfhir avatar Jul 18 '19 14:07 Alfhir