Skip to content

Commit 8ff4a64

Browse files
author
Mario Borna Mjertan
committed
Slightly improve writing style
1 parent 36d4461 commit 8ff4a64

File tree

5 files changed

+25
-27
lines changed

5 files changed

+25
-27
lines changed

website/docs/basics/basics-intro.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ id: basics-intro
33
title: Basics
44
---
55

6-
Before WordPress 5.0 release, the themes were mostly PHP based on some JavaScript and CSS. Now it's a bit different because we have PHP in the core, JavaScript (specifically React.js) in the block editor, and some styles in the editor and the theme parts of the website.
6+
Prior to WordPress 5.0, themes were mostly PHP-based, with JavaScript used only to provide interactive functionality on the website.
7+
Now it's a bit different because we have PHP in the core, JavaScript (specifically React.js) in the block editor, and some styles in the editor and the theme parts of the website.
78

89
Now that everything is different, we must adapt to the changes as well.
910

website/docs/basics/wp-cli.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ id: wp-cli
33
title: WP-CLI
44
---
55

6-
[![docs-source](https://img.shields.io/badge/source-eigthshift--libs-blue?style=for-the-badge&logo=php&labelColor=2a2a2a)](https://github.com/infinum/eightshift-libs)
6+
[![docs-source](https://img.shields.io/badge/source-eightshift--libs-blue?style=for-the-badge&logo=php&labelColor=2a2a2a)](https://github.com/infinum/eightshift-libs)
77

8-
We have already mentioned the WP-CLI feature of Eightshift Boilerplate. Now, let's dig a little deeper into this awesome feature. We took our time to set up a bunch of WP-CLI commands that will help you set everything up and use all our features without worrying about correct names, files, and organization.
8+
Eightshift Development Kit provides extensive [WP-CLI](https://wp-cli.org/) tooling, allowing you to automate bootstrapping of common code, adding blocks from the Frontend Libs library to your projects and more using `wp boilerplate`.
99

1010
## How it works
1111

12-
In your project's entry point, you have something like this:
12+
In your project's entry point (usually `functions.php`), you'll find something along these lines:
1313

1414
```php
1515
/**
@@ -20,13 +20,13 @@ if (class_exists(Cli::class)) {
2020
}
2121
```
2222

23-
This code loads WP-CLI class from Eightshift Libs responsible for registering all of our custom commands. Keep in mind that, since WP-CLI code loads inside the theme/plugin, that same theme/plugin **must** be activated in the WordPress admin.
23+
This code loads the WP-CLI class from Eightshift Libs, which handles command registration for all of our commands. As this command registration is part of the theme/plugin code, this means that the same theme/plugin **must be activated** for `wp boilerplate` to work.
2424

2525
To run the WP-CLI command and see what you can use, run this command in your terminal:
2626

2727
`wp boilerplate --help`
2828

29-
> By default, your project's WP-CLI commands run under the parent name `boilerplate` defined in the upper code.
29+
> By default, your project's WP-CLI commands run under the parent name `boilerplate`, as defined above.
3030
3131
You can change that by simply replacing the string inside the load method like this:
3232

@@ -39,23 +39,22 @@ if (class_exists(Cli::class)) {
3939
}
4040
```
4141

42-
Now, your project's WP-CLI loads like this:
42+
Now, your project's WP-CLI commands are available using:
4343

4444
`wp superCoolTheme --help`.
4545

4646
This is especially handy when you have multiple Eightshift Boilerplate powered themes or plugins installed. In that case, you should change the WP-CLI parent name on each of the projects.
4747

4848
## Options and commands
4949

50-
When you type each command in the terminal, it will do some action. Some commands will ask you for additional parameters. You can see them if you run the `command name` and `--help` like this:
50+
To get to know which commands are available and what do they do, run `wp boilerplate --help`.
51+
The `--help` argument is available on all of our commands and provides a description of the command and a list of required and optional parameters for the command.
5152

5253
`wp boilerplate create_config --help`
5354

54-
Under the `OPTIONS`, you can see all required and optional parameters you can pass to the command to fine-tune your output.
55-
5655
### Commands
5756

58-
We have defined a few command prefixes:
57+
We use these common prefixes for commands:
5958

6059
- **create** - services classes that will be copied to your project.
6160
- **init** - additional functions, methods and helpers that will be copied to your project.
@@ -65,16 +64,15 @@ We have defined a few command prefixes:
6564

6665
> **Make WP-CLI your best friend, and your coding life will be much more comfortable, trust us.**
6766
68-
We will explain some classes that we think are necessary in more detail in the next chapter. For the rest of the classes, you can find the descriptions by running `--help` after each command.
69-
67+
While we might go into more details about some of these commands, we won't be documenting all of them here - use the built-in manuals for more information about particular commands and to discover what's available. Don't gloss over them, as using `wp boilerplate` is a particularly useful tool when building projects with Eightshift Development Kit.
7068
## Running commands in multisite
7169

72-
When you are running a multisite setup you must always provide the additional `--url` parameter because without that parameter WordPress will always run the code from the current primary domain set in the `wp-config.php`.
70+
When you are running a multisite setup, you should always provide the additional `--url` parameter. Otherwise, WP-CLI will always run the command on the main site.
7371

74-
Here is an example for command running from the primary domain:
72+
Here is an example for command running on the primary site:
7573

7674
`wp boilerplate create_config`
7775

78-
and here is an example for command running in the sub site:
76+
and here is an example for command running on the subsite:
7977

8078
`wp boilerplate create_config --url='custom.domain.com'`

website/docs/eightshift-frontend-libs.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,26 @@ id: eightshift-frontend-libs
33
title: Eightshift Frontend Libs
44
---
55

6-
[![docs-source](https://img.shields.io/badge/source-eigthshift--frontend--libs-yellow?style=for-the-badge&logo=javascript&labelColor=2a2a2a)](https://github.com/infinum/eightshift-frontend-libs/tree/develop/blocks/init/src/blocks/)
6+
[![docs-source](https://img.shields.io/badge/source-eightshift--frontend--libs-yellow?style=for-the-badge&logo=javascript&labelColor=2a2a2a)](https://github.com/infinum/eightshift-frontend-libs/tree/develop/blocks/init/src/blocks/)
77

8-
This library is meant to bring the modern front-end development tools to the [Eightshift Boilerplate](https://github.com/infinum/eightshift-boilerplate) or [Eightshift Boilerplate Plugin](https://github.com/infinum/eightshift-boilerplate-plugin), but you can use it on any WordPress project.
8+
This library is meant to bring modern front-end development tools to the [Eightshift Boilerplate](https://github.com/infinum/eightshift-boilerplate) or [Eightshift Boilerplate Plugin](https://github.com/infinum/eightshift-boilerplate-plugin), but you can use it on any WordPress project.
99

1010
## Prerequisites
1111

1212
The knowledge of the core editor components and React.js is recommended, since this library is focused on working with the new block editor and contains custom blocks. If you want to create your custom blocks, that knowledge will come in handy.
1313

14-
The library can be used for pure Webpack/JS/Scss functionality, but if you want to use our blocks, [Eightshift Libs](https://github.com/infinum/eightshift-libs/) must be used in tandem because they handle block registration, etc.
14+
The library can be used for pure Webpack/JS/SCSS functionality, but if you want to use our blocks, [Eightshift Libs](https://github.com/infinum/eightshift-libs/) must be used in tandem because they handle block registration, attribute handling and more.
1515

1616
### The library contains:
1717

1818
- All JS packages required for the Webpack build
1919
- ESLint ruleset
20-
- StyleLint ruleset
20+
- Stylelint ruleset
2121
- Babel ruleset
2222
- A collection of useful front-end utility modules
2323
- The complete storybook of over 30+ useful blocks and components
24-
- Block editor block example
25-
- Block editor blocks initial setup for the [Eightshift Boilerplate](https://github.com/infinum/eightshift-boilerplate)
26-
- Some cool custom components for block editor
24+
- Block editor block examples
25+
- A growing collection of blocks and components
2726
- The complete Webpack build for [Eightshift Boilerplate](https://github.com/infinum/eightshift-boilerplate)
2827
- Helpers for creating dynamic block editor blocks
2928
- ...

website/docs/theme.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ All additional steps after the initial setup are done using WP_CLI commands, so
2222

2323
## Specify version to create
2424

25-
In order to be able to test boilerplate with different library versions you can provide 2 additions attributes to this command and specify library versions.
25+
If you want to specify a version of Eightshift Libs or Frontend Libs to use, you can use add two additional attributes to this command to specify a branch or release to use:
2626

2727
* `--eightshiftLibsBranch`
2828
* `--eightshiftFrontendLibsBranch`
2929

3030
#### Example:
3131

32-
If you want to pull a `develop` branch for the Eightshift frontend libs and a specific branch of the Eightshift libs your command will look like this:
32+
If you want to pull the `develop` branch of the Eightshift Frontend libs and a specific release of the Eightshift Libs:
3333

3434
```bash
3535
npx create-wp-project --eightshiftLibsBranch="release/3.1.0" --eightshiftFrontendLibsBranch="develop"
@@ -50,6 +50,6 @@ npx create-wp-project --help
5050
> You can specify both libraries at once or only one.
5151
5252
## What is next?
53-
Now that we have the theme set on your local environment, let's do something with it.
53+
Now that we've set the theme up on your local environment, let's do something with it.
5454

5555
Please make sure you read the [Basics chapter](basics/basics-intro) to understand better how the project is set and what is included to make your developing experience as smooth as possible.

website/docs/versions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: versions
33
title: Versions
44
---
55

6-
Now that you understand what makes Eightshift tick, here is a quick reminder about what library versions this documentation refers to.
6+
Now that you understand what makes the Eightshift Development Kit tick, here is a quick reminder about what library versions this documentation refers to.
77

88
[![docs-source](https://img.shields.io/badge/version--6.0.0-eightshift--boilerplate-red?style=for-the-badge&logo=)](https://github.com/infinum/eightshift-boilerplate)
99

0 commit comments

Comments
 (0)