Skip to content

Commit 55005ff

Browse files
committed
'Basic guides' corrections
Signed-off-by: Kev Provance <kevin.provance@gmail.com>
1 parent 698833d commit 55005ff

File tree

5 files changed

+38
-33
lines changed

5 files changed

+38
-33
lines changed

docs/guides/basics/core-concepts.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,36 +11,43 @@ to properly grasp how Redux works.
1111
:::
1212

1313
## Never modify core files!
14-
Redux is extremely extensible, which means you can override nearly anything using filters. You will never find a need to modify a core file unless you're helping us to solve a bug. __***NEVER***__ **modify anything inside redux-core**. If you want to change how a field works, build an extension instead. Need to modify a value when it's saved? Use a filter.
14+
Redux is extremely extensible, which means you can override nearly anything using filters. You will never find a need to modify a core file unless
15+
you're helping us to solve a bug. __***NEVER***__ **modify anything inside redux-core**. If you want to change how a field works,
16+
build an extension instead. Need to modify a value when it's saved? Use a filter.
1517

1618
::: danger Why is modifying `redux-core` files a bad practice when embedded in my own product?
1719
Redux is built to run with only one version of the framework code. If you modify core files in your version, which you
1820
embed in a product, there's no guarantee your version will be the version loaded should another product be using Redux.
19-
This will most likely cause conflicts and headaches for you and your clients. By using filters and extensions, you ensure that your code will always be loaded despite the "core" that is instantiated first.
21+
This will most likely cause conflicts and headaches for you and your clients. By using filters and extensions, you ensure that your code always loads
22+
despite the "core" that is instantiated first.
2023
:::
2124

2225
## Object Structure
23-
We need to understand the object structure of Redux in order to understand how it all fits together.
26+
We need to understand the object structure of Redux to understand how it all fits together.
2427

2528
### Field
26-
The lowest building block is a [field](../../configuration/objects/field.md). A [field](../../configuration/objects/field.md) is what is displayed for a user to input data. It has its own set of characteristics depending on the [field type](../../core-fields). At this level, whatever args are set to the [field](../../configuration/objects/field.md) act as an override for all levels above.
29+
The lowest building block is a [field](../../configuration/objects/field.md). A [field](../../configuration/objects/field.md) is what is displayed for a user to input data. It has its own set of characteristics
30+
depending on the [field type](../../core-fields). At this level, whatever args are set to the [field](../../configuration/objects/field.md) act as an override for all levels above.
2731

2832
### Section
29-
A [section](../../configuration/objects/section.md) is a grouping of [fields](../../configuration/objects/field.md). It groups everything together into its own array. It containes a number of arguments that can be passed down to the [fields](../../configuration/objects/field.md) below, provided the [fields](../../configuration/objects/field.md) below do not specify those same arguments on their own declaration. Again, the [fields](../../configuration/objects/field.md) level args override all.
33+
A [section](../../configuration/objects/section.md) is a grouping of [fields](../../configuration/objects/field.md). It groups everything together into its own array. It containes a number of arguments that passed down
34+
to the [fields](../../configuration/objects/field.md) below, provided the [fields](../../configuration/objects/field.md) below do not specify those same arguments on their own declaration. Again, the [fields](../../configuration/objects/field.md)
35+
level args override all.
3036

3137
### Box
32-
In some cases, such as is with [metaboxes](../../core-extensions/metaboxes-lite.md), an extra grouping is required. Hence, a box. A box is simply a container with a bunch of [sections](../../configuration/objects/section.md) within it. The primary purpose of a box is placement on the screen.
38+
In some cases, such as is with [metaboxes](../../core-extensions/metaboxes-lite.md), an extra grouping is required. Hence, a box. A box is simply a container with a bunch of [sections](../../configuration/objects/section.md)
39+
within it. The primary purpose of a box is placement on the screen.
3340

3441
### Instance
3542
Instance level arguments are known as [global arguments](../../configuration/global_arguments.md). They impact all areas of
3643
the instance. Typically, these are arguments that affect how Redux performs, but they can set an entire instance to display
37-
a control panel in the [customizer only](../../configuration/global_arguments.md#customizer-only). If you're not sure what's
38-
going on, the problem may be in the [global args](../../configuration/global_arguments.md).
44+
a control panel in the [customizer only](../../configuration/global_arguments.md#customizer-only). If you're not sure what's going on, the problem may be in the [global args](../../configuration/global_arguments.md).
3945

40-
Remember, there can be multiple instances of Redux running in a single WordPress install. This means that all products based on Redux, be it plugins or the theme can be running at once without impacting one another.
46+
Remember, there can be multiple instances of Redux running in a single WordPress installation. This means that all products based on Redux, be it
47+
plugins or the theme can be running at once without impacting one another.
4148

4249
## Arguments
43-
Every object has arguments and every level of nested objects can inherit or override those arguments. When looking at an
50+
Every object has arguments, and every level of nested objects can inherit or override those arguments. When looking at an
4451
argument, make sure you're thinking of how it will impact all the nested items below it (children).
4552

4653
### Global Arguments
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Customizer Integration
22

3-
Redux contains light customizer support. This means Redux supports all the default
4-
fields the WordPress customizer supports. Here is a video demonstrating how implementation of customizer support may be
3+
Redux contains customizer support. Here is a video demonstrating how implementation of customizer support may be
54
used in your theme.
65

76
[![](https://img.youtube.com/vi/Kq-pMi34mvg/0.jpg)](https://www.youtube.com/watch?v=Kq-pMi34mvg)

docs/guides/basics/getting-started.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,12 @@ through to see what suits your particular needs.
1212
:::
1313

1414
## Installing
15-
Redux must be installed to begin using it. The quickest approach is to install the WordPress.org plugin although other
15+
Redux must be installed to begin using it. The quickest approach is to install the WordPress.org plugin, although other
1616
approaches are available. [Read more in our install docs](install.md).
1717

1818
## Core Concepts
19-
Another great guide to review is our core concepts. The Redux may be confusing without understanding how it's structured. [Read more in our core concepts docs](core-concepts.md)
19+
Another great guide to review is our core concepts. The Redux may be confusing without understanding how it's structured.
20+
[Read more in our core concepts docs](core-concepts.md)
2021

2122
## Basic Config
2223
Once Redux is installed, we can begin digging in. Let's begin with a basic config. The [barebones example](https://github.com/reduxframework/redux-framework/blob/master/sample/barebones-config.php)

docs/guides/basics/install.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ through to see what suits your particular needs.
1313
## Downloading
1414

1515
### WordPress.org Plugin
16-
By using the Redux plugin, you can ensure your users will always be up-to-date with the most stable release.
16+
By using the Redux plugin, you can ensure your users will always be up to date with the most stable release.
1717

1818
[WordPress.org Plugin](https://wordpress.org/plugins/redux-framework)
1919

@@ -24,7 +24,7 @@ is highly active. We work with the community to vet any changes or improvements
2424
[GitHub Repository](https://github.com/reduxframework/redux-framework/)
2525

2626
## Using Composer
27-
You're not a developer, you're a code jedi. You laugh at copy and paste! Why not try Composer and Redux. It will make
27+
You're not a developer, you're a code jedi! You laugh at copy and paste! Why not try Composer and Redux. It will make
2828
your development time that much easier.
2929

3030
### WP Packagist
@@ -57,7 +57,7 @@ These releases are often pre-release to WordPress.org. Although they are conside
5757
```
5858

5959
### Repo Master Branch
60-
Go forth young Padawan. Do not underestimate the potential bugs of the master branch. :)
60+
Go forth, young Padawan. Do not underestimate the potential bugs of the master branch. :)
6161

6262
```json
6363
{
@@ -93,14 +93,12 @@ In this download, you'll find many more files than found in the plugin. It shoul
9393

9494
```text
9595
redux-framework/
96-
├── .tx/
97-
├── bin/
98-
├── code-styles/
96+
├── .github/
97+
├── codestyles/
9998
├── redux-core/
10099
├── sample/
101100
├── sample-config.php
102101
├── barebones-config.php
103-
├── tests/
104102
```
105103

106104
::: danger Embedding the Redux repo will not pass approval

docs/guides/basics/support-defined.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,42 @@ sidebarDepth: 0
44
---
55

66
# Getting Help: Our Support Defined
7-
We've included this document in order to help everyone understand what we will and will not support. Please read it carefully and
7+
We've included this document to help everyone understand what we will and will not support. Please read it carefully and
88
with understanding as we wish to truly convey our intent to help.
99

1010
::: warning Table of Contents
1111
[[toc]]
1212
:::
1313

1414
### Who are we?
15-
We maintain an open source project entitled Redux Framework. It is used by millions of users across in all walks of life all across the
15+
We maintain an open source project entitled Redux Framework. It is used by millions of users across in all walks of life across the
1616
world. Redux is used primarily by developers. That means if users of our developers
17-
approach us for help, it is often difficult and sometimes impossible to provide the requested support.
17+
approach us for help, it's often challenging and sometimes impossible to provide the requested support.
1818

1919
### Why is that?
2020
Redux is built for developers. A basic to moderate understanding of PHP, error logs, and JavaScript bugs is required. It is impossible
2121
for us to provide solutions to those without the experience of coding in these spaces. We mean no disrespect, but often times it
2222
takes us five times longer to explain a standard developer concept to a non-developer.
2323

24-
### But I'm a user, does that mean I'm out of luck?!
24+
### But I'm a user; does that mean I'm out of luck?!
2525
Not entirely. We want to help. We really do. We simply need to be compensated for our time. Not only are we debugging a
2626
potential problem in OUR code, but also need to debug a problem within another developer's code to help. To do this, we
27-
need you to support our project by paying for premium support.
27+
need you to support our project by paying for premium support.
2828

2929
### But that's not fair!
3030
It’s also not fair that your developer may have stopped supporting you. We sympathize. However, we'll be required to find out
3131
exactly what your developer was doing and that takes a LOT of time on our part. We need to charge for that service.
32-
Solving problems in third party applications that utilize Redux takes us away from our means as well as time spent
32+
Solving problems in third party applications that use Redux takes us away from our means as well as time spent
3333
making Redux better.
3434

3535
### Truly, we want to help!
36-
We truly do want to help! But at the end of the day we can't offer unlimited support for circumstances beyond our control.
36+
We truly do want to help! But at the end of the day, we can't offer unlimited support for circumstances beyond our control.
3737

3838
### Best of Luck!
39-
We genuinely wish you best of luck. We're not attempting to insult. We will gladly solve problems in our code, but we cannot
40-
solve problems in another developers code without compensation.
39+
We genuinely wish you the best of luck. We're not attempting to insult. We will gladly solve problems in our code, but we cannot
40+
solve problems in another developer's code without compensation.
4141

4242
### I still want support!
43-
If you're still interested in support from us, you need to start by [generating a support hash](generating-a-support-hash.md).
44-
Please do not be disappointed if we inform you that we require a purchase of [premium support](https://redux.io/extensions/premium-support)
45-
for us to further assist you if your problem is outside the scope of our framework.
43+
Please do not be disappointed if we inform you that we require a purchase of premium support
44+
for us to further help you if your problem is outside the scope of our framework. For a quote, please [submit a request](https://redux.io/contact/) via our Contact Form.
45+
Breifly describe your problem. If we're able to help, we'll send you a quote and request additional information from you then.

0 commit comments

Comments
 (0)