fix(docs): add better written docs (scullyio#389)

* fix(docs): add better written docs The following docs have been finished: plugins, recomended-plugins, release-for-v8, learn, and shocase * fixfix(docs): add missing new lines in notes * fix(docs): add improved written documentation for scully-lib-core * fix(docs): add better written documentation for scully-cmd-line * fix(docs): add better written docs for scully-configuration * fix(docs): add better written docs for utils
brandonroberts · Mar 20, 2020 · 5e1b6a7 · 5e1b6a7
1 parent 1c8afa2
commit 5e1b6a7
Show file tree

Hide file tree

Showing 15 changed files with 291 additions and 262 deletions.
diff --git a/docs/blog.md b/docs/blog.md
@@ -62,6 +62,6 @@ The following table shows all available options:
 
 | option         | description                                            | default   |
 | -------------- | ------------------------------------------------------ | --------- |
-| `name`         | define the name for the created post                   | 'blog-X'  |
-| `target`       | define the target directory for the new post file      | 'blog'    |
-| `metaDataFile` | use a meta data yaml template from a file for the post | undefined |
+| `name`         | Define the name for the created post                   | 'blog-X'  |
+| `target`       | Define the target directory for the new post file      | 'blog'    |
+| `metaDataFile` | Use a meta data yaml template from a file for the post | undefined |
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -112,7 +112,9 @@ Now, it is possible to loop through the links inside the template by opening the
 
 At this point, you have your Angular project with Scully successfully installed.
 
-#### IMPORTANT: _Scully requires the distribution files in the `./dist/my-scully-app` folder._
+#### IMPORTANT:
+
+_Scully requires the distribution files in the `./dist/my-scully-app` folder._
 
 **NOTE:** If the angular application outputs the distribution files directly into the root folder `./dist`. Scully is not able to copy all files. This is an OS file-system issue.
 

diff --git a/docs/getting-started_es.md b/docs/getting-started_es.md
@@ -57,9 +57,13 @@ CREATE scully.config.js (65 bytes)
 UPDATE package.json (1507 bytes)
 ```
 
-#### IMPORTANTE: _Scully requiere que el router esté presente en su aplicación, no olvide agregarlo._
+#### IMPORTANTE:
 
-#### IMPORTANTE: _Scully requiere que los archivos de distribución estén en una subcarpeta de `./dist`_
+_Scully requiere que el router esté presente en su aplicación, no olvide agregarlo._
+
+#### IMPORTANTE:
+
+_Scully requiere que los archivos de distribución estén en una subcarpeta de `./dist`_
 
 Si tienes una aplicación Angular, que genera los archivos de distribución directamente en la raíz de `./dist` Scully no puede copiar todos los archivos del dist. Este es un problema del sistema de archivos del sistema operativo. No podemos copiar recursivamente en una subcarpeta de dist. La solución es configurar la opción `architect-> build-> options-> outputPath` en una subcarpeta.
 

diff --git a/docs/learn.md b/docs/learn.md
@@ -1,3 +1,8 @@
-# Scully Learn
+---
+title: Learn
+order: 1100
+---
 
-[Full Documentation ➡️](scully.md)
+# Learn Scully
+
+Coming soon!