[NPMCLI-12] Polish and streamline commands doc and README.md Created: 10/May/16 Updated: 22/Aug/16 Resolved: 16/Aug/16 |
|
| Status: | Closed |
| Project: | Magnolia CLI |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | 0.0.1 |
| Type: | Task | Priority: | Neutral |
| Reporter: | Federico Grilli | Assignee: | Christoph Meier |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | 0d | ||
| Time Spent: | 0.75d | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||||||
| Template: |
|
||||||||||||
| Acceptance criteria: |
Empty
|
||||||||||||
| Task DoR: |
Empty
|
||||||||||||
| Documentation update required: |
Yes
|
||||||||||||
| Date of First Response: | |||||||||||||
| Sprint: | Basel 57 | ||||||||||||
| Story Points: | 2 | ||||||||||||
| Description |
|
All command help texts and the README.md needs a polishing. One of the worst case is the help text of the build command which is using the term "Magnolia light module" (imho) completely wrong. A follow up to README.md needs to be expanded with examples. Also review commands help output. |
| Comments |
| Comment by Christoph Meier [ 10/Aug/16 ] |
|
In this context docs - https://documentation.magnolia-cms.com/display/DOCS/Magnolia+npm-cli - must be checked. Prbly. README.md and docs can be "married" somehow :-p |
| Comment by Christoph Meier [ 15/Aug/16 ] |
|
I have aligned the command help-texts and the README.md with the docs. page. |