aurelia / aurelia/documentation

Documentation doesn't reflect CLI capabilities

Open
#340 2 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
No language data
Stars
104
Forks
108
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

Research direction

Start with the Aurelia Validation basics page and the Aurelia CLI page linked in the issue, comparing their package-install and generation instructions with the CLI capabilities described here. Find other documentation pages that give outdated npm or jspm instructions, then update the affected guidance to consistently explain the preferred CLI workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
cli
Domain
cli, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.