Skip to content

Commit 65be7bc

Browse files
authored
refactor(docs): fix minor errors
* refactor(docs): add right links and minor fixes * refactor(docs): add link to scully.md * refactor(docs): links
1 parent e19346c commit 65be7bc

8 files changed

Lines changed: 53 additions & 17 deletions

File tree

docs/blog.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,23 @@ If you don't want the folder to be called 'blog', you can run a longer command t
2222
To name your blog folders and components another name, run the following command with your own name:
2323

2424
```bash
25-
ng g @scullyio/init:markdown --name=cooking
25+
ng g @scullyio/init:markdown --name=my-test --slug=my-slug-id
2626
```
2727

28+
or
29+
30+
```bash
31+
ng g @scullyio/init:markdown --name="my text" --slug="my slug id"
32+
```
33+
34+
2835
## Generating New Blog Posts
2936

30-
To add a new blog post, run the following command. T
37+
To add a new blog post, run the following command.
3138

3239
```
33-
ng g @scullyio/init:post --title
40+
ng g @scullyio/init:post --name="This is my post"
3441
```
3542

3643
---
37-
Next: [Full Documentation ➡️](scully.md)
44+
[Full Documentation ➡️](scully.md)

docs/getting-started.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Scully - Getting Started
22

3-
The first thing you need to get started with Scully is a working Angular app using Angular 8.* or 9.*.
3+
The first thing you need to get started with Scully is a working Angular app using Angular 9.*.
44

55
This getting started doc covers the three steps to adding Scully into your project.
66

@@ -15,9 +15,25 @@ To install Scully, do the following: From the root directory of your Angular pro
1515
ng add @scullyio/init
1616
```
1717

18-
At this point, Scully has been added to your project. The most important part of the installation is the addition of the
19-
Scully configuration file: `scully.config.js` (_soon this will be `scully.config.ts`_). To learn more about this file,
20-
read [Scully Configuration](scully-configuration.md) docs.
18+
The command above set up the necessary to start to work with Scully (_we go to get more deep about this in next releases._).
19+
20+
If the installation was success you can read a message similar to this one.
21+
22+
```bash
23+
Installed packages for tooling via yarn.
24+
✔ Added dependency
25+
✔ Import HttpClientModule into root module
26+
UPDATE package.json (1447 bytes)
27+
UPDATE src/app/app.module.ts (472 bytes)
28+
UPDATE src/polyfills.ts (3035 bytes)
29+
UPDATE src/app/app.component.ts (325 bytes)
30+
✔ Packages installed successfully.
31+
✔ Update package.json
32+
CREATE scully.config.js (65 bytes)
33+
UPDATE package.json (1507 bytes)
34+
```
35+
36+
## @scullyio/init:blog
2137

2238
## Build
2339

@@ -34,7 +50,7 @@ That's it. You're done! In your project directory, you now have a `/dist/static`
3450
of your app.
3551

3652
__NOTE:__ If you had any errors or warning during the build phase, please follow the instructions in the errors/warnings
37-
(if applicable) or [submit an issue](issues).
53+
(if applicable) or [submit an issue](https://github.com/scullyio/scully/issues/new).
3854

3955
## Test
4056

@@ -60,4 +76,4 @@ HTML correctly.
6076

6177

6278
---
63-
Next: [Full Documentation ➡️](scully.md)
79+
[Full Documentation ➡️](scully.md)

docs/issues.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
# Scully Issues
22

3-
Better documentation will be added for creating issues.
3+
Better documentation will be added for creating issues.
4+
5+
6+
[Full Documentation ➡️](scully.md)

docs/plugins.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,7 @@ users, it will return a list of userIds.
5656

5757
## <a name="transform-plugins"></a> Data Transform Plugins
5858

59-
Describe data transform plugins
59+
Describe data transform plugins
60+
61+
62+
[Full Documentation ➡️](scully.md)

docs/pre-requisites.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ Those 3 topics are very important to successfully start using Scully .
1717

1818

1919

20-
Prev: [Scully ⬅️️](scully.md) | Next: [Getting Started ➡️](getting-started.md)
20+
[Full Documentation ➡️](scully.md)

docs/recommended-plugins.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,9 @@ _If you would like to add a plugin to this list, please submit a PR to the `docs
1111

1212
## Community Plugins
1313

14-
- (_be the first to submit a plugin_)
14+
- (_be the first to submit a plugin_)
15+
16+
17+
18+
19+
[Full Documentation ➡️](scully.md)

docs/scully-configuration.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# Scully Configuration
22

33
The center of every scully project is the `scully.config.js`. This config file must export the configuration for your
4-
scully build. Whether you need to add a
4+
scully build.
5+
6+
[Full Documentation ➡️](scully.md)

schematics/scully/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ You can copy one of the seed project for test more fast.
3737
```
3838
ng add @scullyio/init
3939
ng g @scullyio/init:blog
40-
ng g @scullyio/init:markdown --name
41-
ng g @scullyio/init:post --title
40+
ng g @scullyio/init:post --name="This is my post"
41+
ng g @scullyio/init:markdown --name=my-exmaple --slug=id
4242
npm run scully
4343
```
4444

0 commit comments

Comments
 (0)