ionic: add page #1137
ionic: add page #1137
Conversation
|
|
There was a problem hiding this comment.
Also, kindly fix the travis errors-
Error: Parse error on line 11:
...t {{{project_name}}` `- Create a new
-----------------------^
Expecting 'NEWLINE', 'TEXT', 'DASH', 'BACKTICK', got 'COMMAND_TEXT'
pages/common/ionic.md:3: TLDR004 Command descriptions should end in a period
pages/common/ionic.md:5: TLDR005 Example descriptions should end in a colon
pages/common/ionic.md:9: TLDR005 Example descriptions should end in a colon
pages/common/ionic.md:10: TLDR103 Command example is missing its closing backtick
|
|
||
| > Complete open source SDK to build top quality native and progressive web apps using Angular JS and Apache Cordova. | ||
|
|
||
| - Installation. |
There was a problem hiding this comment.
tldr is a man page alternative. So no need to provide installation steps.
There was a problem hiding this comment.
To clarify, it's not about need (beginners would certainly welcome help with installation), but about scope: we have very limited space due to our commitment to provide short pages, and we focus on usage documentation; installation instructions (which often can be quite exhaustive to support multiple platforms, package managers, etc.) can clash with these goals, so we choose not to include them for any of the tools we cover. I hope you can understand :)
|
|
||
| - Create a new project with a local template | ||
|
|
||
| `ionic start {{project_name}} {{~/path/to/template}}` |
There was a problem hiding this comment.
{{~/path/to/template}} => {{path/to/template}}
|
|
||
| `ionic start {{project_name}} {{codepen_url}}` | ||
|
|
||
| - Viewing the app in a browser |
There was a problem hiding this comment.
"Viewing the app" => "View the app"
|
|
||
| `ionic start {{project_name}} {{~/path/to/template}}` | ||
|
|
||
| - Create project using template on GitHub |
There was a problem hiding this comment.
In the same vein, "using a template".
|
|
||
| `ionic start {{project_name}} {{username}}/{{repo}}` | ||
|
|
||
| - Create project using template on Codepen |
| @@ -0,0 +1,31 @@ | |||
| # ionic | |||
|
|
|||
| > Complete open source SDK to build top quality native and progressive web apps using Angular JS and Apache Cordova. | |||
There was a problem hiding this comment.
We tend to omit adjectives ("complete", "open source", "top quality") in the main description. Stick to describing what it is and what it does :)
Btw, "progressive web app" (PWA) seems to be kind of a specialized term, which is explained even to ionic users. I think it's not generic/informative enough to be included here. Maybe "top quality native and progressive web apps" --> "native-like mobile web apps"?
|
@jobinlawrance - any updates on this ? |
|
Hi @jobinlawrance - Please sign the CLA so that we can move forward on this PR. I am closing this one after getting no response from you. Feel free to reopen this anytime, and we can resume our work on it ! |
|
@jobinlawrance if you have any objections regarding the CLA, we are also open to hear them :) |
No description provided.