Skip to content

Commit eae148e

Browse files
beemanVillanuevand
authored andcommitted
docs(scully): fix typo / update docs
1 parent 288b6ae commit eae148e

6 files changed

Lines changed: 19 additions & 14 deletions

File tree

docs/getting-started.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,14 @@
22

33
## Prerequisites
44
The first thing you need to get started with Scully is a working Angular app using **Angular 9.x.x**.
5-
Find more infos here ([👉 angular.io/cli](https://angular.io/cli)
5+
6+
You can create a new Angular 9 app using the following command:
7+
8+
```bash
9+
npx -p @angular/cli@next ng new my-scully-app
10+
```
11+
12+
Find more info here ([👉 angular.io/cli](https://angular.io/cli)
613

714
__NOTE:__ Scully will use Chromium. Make sure your Operating System (and its restrictions by your administrator) allow installing and executing Chromium.
815

docs/issues.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
# Scully Issues
22

33

4-
For create Bug report go to [Scully Bug template](https://github.com/scullyio/scully/issues/new?assignees=&labels=bug&template=---bug-report.md&title=).
4+
To create a bug report go to [Scully Bug template](https://github.com/scullyio/scully/issues/new?assignees=&labels=bug&template=---bug-report.md&title=).
55

6-
To propose a new Feature go to [Scully Feature request](https://github.com/scullyio/scully/issues/new?assignees=&labels=enhancement&template=---feature-request.md&title=)
6+
To propose a new feature go to [Scully Feature request](https://github.com/scullyio/scully/issues/new?assignees=&labels=enhancement&template=---feature-request.md&title=)
77

8-
If do you want
9-
10-
Better documentation will be added for creating issues.
8+
We are working on better documentation for creating issues.
119

1210

1311
[Full Documentation ➡️](scully.md)

docs/pre-requisites.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ Before you start building awesome sites with **Scully**, you will need to unders
55

66
- Command Line Interface (CLI)
77
- GIT
8-
- Node
8+
- Node.js
99

1010
Those 3 topics are very important to successfully start using Scully .
1111

1212
### Software tools needed to work with Scully are:
1313

14-
- Node 10 or higher.
14+
- Node.js 10 or higher.
1515
- Angular CLI version 9.
1616

1717

docs/scully-configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Scully Configuration
22

3-
The center of every scully project is the `scully.config.js`. This config file must export the configuration for your
3+
The center of every scully project is the file `scully.config.js`. This config file must export the configuration for your
44
scully build.
55

6-
Better documentation will be added for `scully.config.js` file.
6+
Better documentation will be added for the `scully.config.js` file.
77

88

99

docs/scully.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
## What is Scully?
44

55
**Scully** is freaking awesome. Why? Because it can create static sites using Angular.
6-
so basically **Scully** is a SSG (static site generator) for Angular.
6+
So basically **Scully** is a SSG (static site generator) for Angular.
77

88
### How does it do it?
99

10-
The magic happens thanks to its node CLI application. It allows you to use schematics for a simple work flow.
10+
The magic happens thanks to its Node.js CLI application. It allows you to use schematics for a simple work flow.
1111

12-
Scully works on Windows, Linux and MacOS.
12+
Scully works on Windows, Linux and macOS.
1313

1414
Visit one of the following topics:
1515

scully/utils/config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ export const updateScullyConfig = async (config: Partial<ScullyConfig>) => {
5858
const newConfig = Object.assign({}, scullyConfig, config);
5959
if (config.outFolder === undefined) {
6060
logWarn(
61-
`The option outFolder isn't configured, we are using "${yellow(scullyConfig.outFolder)} by default."`
61+
`The option outFolder isn't configured, using default folder "${yellow(scullyConfig.outFolder)}".`
6262
);
6363
} else {
6464
config.outFolder = join(angularRoot, config.outFolder);

0 commit comments

Comments
 (0)