Skip to content

Commit a8b1904

Browse files
committed
docs: Improved clarity and formatting in getting started guide
1 parent aa0f036 commit a8b1904

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/pages/guide/getting-started.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,49 @@
11

22
# Getting Started
33

4-
There are three packages available for gridify in the nuget repository.
4+
There are three packages available for gridify in the nuget repository:
55

66
- [Gridify](https://www.nuget.org/packages/Gridify/)
77
- [Gridify.EntityFramework](https://www.nuget.org/packages/Gridify.EntityFramework/)
88

99
::: tip
10-
If you are using the Entity framework in your project, you should install the `Gridify.EntityFramework` package instead of `Gridify`.
10+
If you are using the Entity Framework in your project, you should install the `Gridify.EntityFramework` package instead of `Gridify`.
1111

12-
This package has the same functionality as the `Gridify` package, but it is designed to be more compatible with [Entity Framework](./extensions/entityframework).
12+
This package provides the same functionality as the `Gridify` package but is designed to be more compatible with [Entity Framework](./extensions/entityframework).
1313
:::
1414

1515
---
16+
1617
- [Gridify.Elasticsearch](https://www.nuget.org/packages/Gridify.Elasticsearch/)
1718

1819
::: tip
19-
In order to use Gridify with Elasticsearch it's necessary to install [`Gridify.Elasticsearch`](./extensions/elasticsearch).
20+
To use Gridify with Elasticsearch, it's necessary to install [`Gridify.Elasticsearch`](./extensions/elasticsearch).
2021
:::
2122

2223
---
2324

24-
If you're developing in a JavaScript or TypeScript environment and need to create dynamic queries on the client side for server-side operations,
25-
Gridify also offer a lightweight client library. [gridify-client](./extensions/gridify-client)
25+
If you are developing in a JavaScript or TypeScript environment and need to create dynamic queries on the client side for server-side operations,
26+
Gridify also offers a lightweight client library. [gridify-client](./extensions/gridify-client)
2627

2728
- [Gridify Client (JS/TS)](https://www.npmjs.com/package/gridify-client)
2829

2930
## Installation
3031

3132
:::: code-group
3233

33-
```shell-vue [Gridify]
34+
```shell-vue[Gridify]
3435
dotnet add package Gridify --version {{ $version }}
3536
```
3637

37-
```shell-vue [Gridify.EntityFramework]
38+
```shell-vue[Gridify.EntityFramework]
3839
dotnet add package Gridify.EntityFramework --version {{ $version }}
3940
```
4041

41-
```shell-vue [Gridify.Elasticsearch]
42+
```shell-vue[Gridify.Elasticsearch]
4243
dotnet add package Gridify.Elasticsearch --version {{ $version }}
4344
```
4445

45-
```shell-vue [Gridify Client (JS/TS)]
46+
```shell-vue[Gridify Client (JS/TS)]
4647
npm i gridify-client
4748
```
4849

@@ -52,8 +53,7 @@ npm i gridify-client
5253

5354
After installing the package, you can use the `Gridify` namespace to access the package classes and static Extension methods.
5455

55-
56-
``` csharp
56+
```csharp
5757
using Gridify;
5858
```
5959

@@ -62,4 +62,4 @@ using Gridify;
6262
There are two ways to start using Gridify:
6363

6464
- Using the [Extension](./extensions.md) methods
65-
- Using [QueryBuilder](./queryBuilder.md)
65+
- Using [QueryBuilder](./querybuilder.md)

0 commit comments

Comments
 (0)