Skip to content

Commit 73363d6

Browse files
committed
Typo
1 parent 8e728aa commit 73363d6

2 files changed

Lines changed: 13 additions & 13 deletions

File tree

docs/guide/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ For **products**, we decide that we don't need to build a `Show Page`:
2929

3030
The product `Entity List` may have filters, sorting columns and search, and an `Entity state` to manage the published state of each product.
3131

32-
Finally, **orders**, must be listed, detailed and updatable, and we also need to manage the **product** list of each order. That's an `Entity List` linking to a `Show Page` which contains another `Entity List`:
32+
Finally, **orders** must be listed, detailed and updated, and we also need to manage the **product** list for each order. That's an `Entity List` linking to a `Show Page` which contains another `Entity List`:
3333

3434
<div style="text-align:center">
3535
<img src="./img/schema-order.png" style="max-width:700px; width:100%">
3636
</div>
3737

3838
Maybe we can add an `Entity Command` to export orders in a CSV file in the `Entity List`, and an `Instance command` on the order `Show Page` to declare the order as shipped.
3939

40-
This is a simple example to illustrate the main concepts of Sharp: we'll see in this guide how to build such structures but also more complexe ones, and how to manage states, commands, dashboards, authorizations, errors, validation... in the process.
40+
This is a simple example to illustrate the main concepts of Sharp: we'll see in this guide how to build such structures but also more complex ones, and how to manage states, commands, dashboards, authorizations, errors, validation... in the process.
4141

4242
## Installation
4343

@@ -46,7 +46,7 @@ Sharp 9 needs Laravel 11+ and PHP 8.3+.
4646
- Add the package with composer: `composer require code16/sharp`
4747
- Then run: `php artisan sharp:install`
4848

49-
This last script will publish required assets, create a `SharpServiceProvider` in the `App\Providers` namespace, and a `SharpMenu` class in the `App\Sharp` namespace.
49+
This last script will publish required assets, create a `SharpServiceProvider` in the `App\Providers` namespace and a `SharpMenu` class in the `App\Sharp` namespace.
5050

5151
## Configuration via a new Service Provider
5252

@@ -71,7 +71,7 @@ class SharpServiceProvider extends SharpAppServiceProvider
7171
```
7272

7373
::: tip
74-
As shown in the [Entity class](entity-class.md) documentation, you can also let Sharp autodiscover your entities.
74+
As shown in the [Entity class](entity-class.md) documentation, you can also let Sharp auto-discover your entities.
7575
:::
7676

7777
This `ProductEntity` class could be written like this:
@@ -91,10 +91,10 @@ We chose to define:
9191

9292
- a `list` class, responsible for the `Entity List`,
9393
- a `show` class, responsible for displaying an `instance` in a `Show Page`,
94-
- a `form` class, responsible for the create and edit `Form`,
94+
- a `form` class, responsible for the creation and edit `Form`,
9595
- and a `policy` class, for authorizations.
9696

97-
Almost each one is optional, in fact: we could skip the `show` and go straight to the `form` from the `list`, for instance.
97+
Almost each one is optional: we could skip the `show` and go straight to the `form` from the `list`, for instance.
9898

9999
We'll get into all those classes in this guide. The important thing to notice is that Sharp provides base classes to handle all the wiring (and more), but as we'll see, the applicative code is totally up to you.
100100

docs/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ Sharp for Laravel is actively maintained and developed and is used in all kinds
2828
## Streamlined Lists
2929

3030
### Customizable columns
31-
Choose and format the data to display, and allow sorting.
31+
Choose and format the data to display and allow sorting.
3232

3333
### Search and filters
3434
Define filters for your lists, with various types and options.
3535

3636
### State management
37-
If your entities have some state, you can manage it easily form here.
37+
If your entities have some state, you can manage it easily from here.
3838

3939
<figure>
4040

@@ -56,7 +56,7 @@ Create commands to act on a single instance or on a selection (filtered list or
5656
Easily attach forms to commands, with validation and confirmation.
5757

5858
### Wizards
59-
Create multi-steps commands with dynamic paths.
59+
Create multistep commands with dynamic paths.
6060

6161
<figure>
6262

@@ -72,10 +72,10 @@ Create multi-steps commands with dynamic paths.
7272
## Comprehensive Forms
7373

7474
### Fields and layout
75-
Use one of the many fields available, and organize them in a layout that fits your needs.
75+
Use one of the many fields available and organize them in a layout that fits your needs.
7676

7777
### Powerful editor with embeds
78-
Sharp's custom editor really allows to create rich content, and includes a clever system to develop custom embeds.
78+
Sharp's custom editor really allows creating rich content and includes a clever system to develop custom embeds.
7979

8080
### Uploads
8181
Manage files with bulk uploads, image transformation, disk and path configuration and precise validation.
@@ -193,9 +193,9 @@ With a clean and documented API.
193193

194194
# About Sharp
195195

196-
Sharp is a long term project developed by [Code 16](https://code16.fr), a web agency based in France, since 2017. We use it in almost all our projects, and we are committed to maintaining and improving it over time.
196+
Sharp is a long-term project developed by [Code 16](https://code16.fr), a web agency based in France, since 2017. We use it in almost all our projects, and we are committed to maintaining and improving it over time.
197197

198-
Sharp 9 relies on Laravel 11, Tailwind CSS, Inertia, Vue and Alpine.JS.
198+
Sharp 9 relies on Laravel, Tailwind CSS, Inertia, Vue and Alpine.JS.
199199

200200
So far we have not implemented any kind of sponsorship system, but we are open to discussing it in the future.
201201

0 commit comments

Comments
 (0)