Skip to content

Commit

Permalink
docs: enable typos action for blog too (refinedev#5603)
Browse files Browse the repository at this point in the history
  • Loading branch information
BatuhanW authored Feb 8, 2024
1 parent d63c69c commit 0cc7038
Show file tree
Hide file tree
Showing 126 changed files with 2,913 additions and 3,442 deletions.
5 changes: 2 additions & 3 deletions .github/workflows/doc-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ on:
branches:
- master
paths:
- "documentation/docs"
- "documentation"
pull_request:
branches:
- master
paths:
- "documentation/docs"
- "documentation"

jobs:
misspell:
Expand All @@ -25,5 +25,4 @@ jobs:
id: check_for_typos
uses: crate-ci/typos@master
with:
files: ./documentation/docs
config: ./typos.toml
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Features

- #### Added swizzle support for `@pankod/refine-core` package

- The swizzle is a command in refine-cli that allows you to customize the refine's supported components and data providers. It allows you to eject selected files from the refine packages and modify depending on your needs.
- The swizzle is a command in refine-cli that allows you to customize the Refine's supported components and data providers. It allows you to eject selected files from the Refine packages and modify depending on your needs.
- [Refer to Swizzle Docs for more information](https://refine.dev/docs/packages/documentation/cli/#swizzle)

Swizzleable components:
Expand Down Expand Up @@ -87,7 +87,7 @@ Features
};
```

## Using `appDir` with **refine**
## Using `appDir` with **Refine**

We've needed to make some changes to the `@pankod/refine-nextjs-router` to make it work with the current structure of the `app` directory feature. To make sure these do not break the current support for `pages` directory, we've added a new exports at the sub path `@pankod/refine-nextjs-router/app` that can be used with the `appDir` option.

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ You have the freedom to select your preferred libraries and frameworks, and the

**Refine** shines on _data-intensive⚡_ enterprise B2B applications like **admin panels**, **dashboards** and **internal tools**. Thanks to the built-in **SSR support**, it can also power _customer-facing_ applications like **storefronts**.

You can take a look at some live examples that can be built using **refine** from scratch:
You can take a look at some live examples that can be built using **Refine** from scratch:

- [Fully-functional CRM Application](https://example.crm.refine.dev/)
- [Fully-functional Admin Panel](https://s.refine.dev/readme-admin-panel)
Expand Down
20 changes: 10 additions & 10 deletions documentation/blog/2021-10-25-mail-subscription-with-refine.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
---
title: Create E-mail Subscription Panel with Refine and Strapi
description: We will make a web application that allows you to quickly create subscribers and send emails to your subscribers in a simple way. We’ll use refine to develop the frontend easily and strapi for backend solutions.
description: We will make a web application that allows you to quickly create subscribers and send emails to your subscribers in a simple way. We’ll use Refine to develop the frontend easily and strapi for backend solutions.
slug: e-mail-subscription-panel-with-refine
authors: melih
tags: [refine, strapi, react, tutorial]
tags: [Refine, strapi, react, tutorial]
image: https://refine.ams3.cdn.digitaloceanspaces.com/website/static/img/placeholder.png
hide_table_of_contents: false
---

:::caution

This post was created using version 3.x.x of **refine**. Although we plan to update it with the latest version of **refine** as soon as possible, you can still benefit from the post in the meantime.
This post was created using version 3.x.x of **Refine**. Although we plan to update it with the latest version of **Refine** as soon as possible, you can still benefit from the post in the meantime.

You should know that **refine** version 4.x.x is backward compatible with version 3.x.x, so there is no need to worry. If you want to see the differences between the two versions, check out the [migration guide](https://refine.dev/docs/migration-guide/).
You should know that **Refine** version 4.x.x is backward compatible with version 3.x.x, so there is no need to worry. If you want to see the differences between the two versions, check out the [migration guide](https://refine.dev/docs/migration-guide/).

Just be aware that the source code example in this post have been updated to version 4.x.x.

:::

We will make a web application that allows you to quickly create subscribers and send emails to your subscribers in a simple way. We’ll use refine to develop the frontend easily and strapi for backend solutions.
We will make a web application that allows you to quickly create subscribers and send emails to your subscribers in a simple way. We’ll use Refine to develop the frontend easily and strapi for backend solutions.

<!--truncate-->

Let's start by creating our strapi and refine projects.
Let's start by creating our strapi and Refine projects.

## Creating API with `Strapi`

Expand Down Expand Up @@ -60,7 +60,7 @@ With these collections and features we have created, we can now create subscribe

## Creating panel with `refine`

Now let's refine the subscription panel. With [superplate](https://github.com/pankod/superplate), we can quickly create a refine project
Now let's Refine the subscription panel. With [superplate](https://github.com/pankod/superplate), we can quickly create a Refine project

```bash
npm create refine-app@latest email-subscription-panel -- -b v3
Expand Down Expand Up @@ -111,7 +111,7 @@ This is a example Refine project:

Let's list our messages and subscribers with refine. Here are the changes we need to make:

- Change Strapi API URL from refine
- Change Strapi API URL from Refine
- Adding resources according to the collection name we created in Strapi

```tsx title="App.tsx"
Expand Down Expand Up @@ -248,7 +248,7 @@ export interface IMail {

In this component:

We used refine's [list](https://refine.dev/docs/examples/list/useSimpleList) and [table](https://refine.dev/docs/api-reference/core/hooks/useTable/) to show our subscribers and messages.
We used Refine's [list](https://refine.dev/docs/examples/list/useSimpleList) and [table](https://refine.dev/docs/api-reference/core/hooks/useTable/) to show our subscribers and messages.

Now let's see how our subscriber panel looks like:

Expand Down Expand Up @@ -352,7 +352,7 @@ export const MailCreate: React.FC<IResourceComponentsProps> = () => {
};
```

Using refine's [form](https://refine.dev/docs/api-reference/antd/hooks/form/useForm/) and [create](https://refine.dev/docs/ui-frameworks/antd/components/basic-views/create/) components, we can now create subscribers and messages with refine.
Using Refine's [form](https://refine.dev/docs/api-reference/antd/hooks/form/useForm/) and [create](https://refine.dev/docs/ui-frameworks/antd/components/basic-views/create/) components, we can now create subscribers and messages with refine.

<img src="https://refine.ams3.cdn.digitaloceanspaces.com/blog/2021-10-25-mail-subscription-with-refine/create.gif" alt="create" />
<br />
Expand Down
14 changes: 7 additions & 7 deletions documentation/blog/2021-10-4-admin-panel-with-nestjs.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
title: Build Fast and Customizable Admin Panel with NestJS
description: We will prepare a simple `job-posting` application. We will also use the refine framework for the admin panel. The project will consist of two parts, api and admin.
description: We will prepare a simple `job-posting` application. We will also use the Refine framework for the admin panel. The project will consist of two parts, api and admin.
slug: customizable-admin-panel-with-nestjs
authors: yildiray
tags: [refine, nestjs, react, tutorial]
tags: [Refine, nestjs, react, tutorial]
image: https://refine.ams3.cdn.digitaloceanspaces.com/website/static/img/placeholder.png
hide_table_of_contents: false
---

:::caution

This post was created using version 3.x.x of **refine**. Although we plan to update it with the latest version of **refine** as soon as possible, you can still benefit from the post in the meantime.
This post was created using version 3.x.x of **Refine**. Although we plan to update it with the latest version of **Refine** as soon as possible, you can still benefit from the post in the meantime.

You should know that **refine** version 4.x.x is backward compatible with version 3.x.x, so there is no need to worry. If you want to see the differences between the two versions, check out the [migration guide](https://refine.dev/docs/migration-guide/).
You should know that **Refine** version 4.x.x is backward compatible with version 3.x.x, so there is no need to worry. If you want to see the differences between the two versions, check out the [migration guide](https://refine.dev/docs/migration-guide/).

:::

In this article, we will prepare a simple `job-posting` application. We will also use the [refine](https://github.com/refinedev/refine) framework for the **admin panel**. The project will consist of two parts, api and admin.
In this article, we will prepare a simple `job-posting` application. We will also use the [Refine](https://github.com/refinedev/refine) framework for the **admin panel**. The project will consist of two parts, api and admin.

<!--truncate-->

Expand Down Expand Up @@ -83,7 +83,7 @@ It created these end-points automatically with nestjsx/crud.

## Refine Admin Panel

**Now let's refine the admin panel.** With [Superplate](https://pankod.github.io/superplate/docs), we can quickly create a `refine` project.
**Now let's Refine the admin panel.** With [Superplate](https://pankod.github.io/superplate/docs), we can quickly create a `refine` project.

```bash
npm create refine-app@latest admin -- -b v3
Expand Down Expand Up @@ -121,7 +121,7 @@ Change api url in [admin/src/App.tsx](https://github.com/refinedev/refine-hackat
const API_URL = "http://localhost:3000";
```

Let's add the listing page in refine for the `companies` crud end-point.
Let's add the listing page in Refine for the `companies` crud end-point.

```tsx title="/admin/src/pages/companies/list.tsx"
import {
Expand Down
14 changes: 7 additions & 7 deletions documentation/blog/2021-10-4-feedback-admin-panel.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,24 @@ title: Create a Feedback Admin panel in 15 Minutes with Refine and Strapi
description: We will quickly create an api with Strapi and then develop its frontend with refine. Thus, let's see how an admin panel can be created in a very short time with the perfect harmony of Strapi and refine.
slug: create-a-feedback-admin-panel-with-refine-and-strapi
authors: salih
tags: [refine, strapi, react, tutorial]
tags: [Refine, strapi, react, tutorial]
image: https://refine.ams3.cdn.digitaloceanspaces.com/website/static/img/placeholder.png
hide_table_of_contents: false
---

:::caution

This post was created using version 3.x.x of **refine**. Although we plan to update it with the latest version of **refine** as soon as possible, you can still benefit from the post in the meantime.
This post was created using version 3.x.x of **Refine**. Although we plan to update it with the latest version of **Refine** as soon as possible, you can still benefit from the post in the meantime.

You should know that **refine** version 4.x.x is backward compatible with version 3.x.x, so there is no need to worry. If you want to see the differences between the two versions, check out the [migration guide](https://refine.dev/docs/migration-guide/).
You should know that **Refine** version 4.x.x is backward compatible with version 3.x.x, so there is no need to worry. If you want to see the differences between the two versions, check out the [migration guide](https://refine.dev/docs/migration-guide/).

:::

In this article, we will create a panel where we can manage the feedback we receive from our web application.

<!--truncate-->

We will quickly create an api with [Strapi.io](https://strapi.io) and then develop its frontend with [refine](https://refine.dev). Thus, let's see how an admin panel can be created in a very short time with the perfect harmony of Strapi and refine.
We will quickly create an api with [Strapi.io](https://strapi.io) and then develop its frontend with [Refine](https://refine.dev). Thus, let's see how an admin panel can be created in a very short time with the perfect harmony of Strapi and refine.

Features that our panel will have:

Expand All @@ -45,9 +45,9 @@ Quite simply, a feedback should have a `description` text field, A `page` text f

### Creating panel with `refine`

Let's create our frontend project with refine's [setting up guide](https://refine.dev/docs/#setting-up).
Let's create our frontend project with Refine's [setting up guide](https://refine.dev/docs/#setting-up).

There are two alternative methods to set up a refine application. We will quickly create our application with [superplate](https://pankod.github.io/superplate).
There are two alternative methods to set up a Refine application. We will quickly create our application with [superplate](https://pankod.github.io/superplate).

```bash
npm create refine-app@latest refine-feedback-client -- -b v3
Expand Down Expand Up @@ -387,7 +387,7 @@ See detailed usage of useSimpleList for adding new filters, adding search entrie
<img src="https://refine.ams3.cdn.digitaloceanspaces.com/blog/2021-10-4-feedback-admin-panel/feedback_overview.gif" alt="feedback_overview" />
<br />

Let's develop feedback widget where we can get feedback to expand the application a little more. For this application, I will develop this component with refine, but you can create this component with Strapi APIs in any way you want.
Let's develop feedback widget where we can get feedback to expand the application a little more. For this application, I will develop this component with Refine, but you can create this component with Strapi APIs in any way you want.

You can look at the code of the component I developed [here](https://github.com/refinedev/refine-hackathon/tree/main/refeedback/src/components/feedback).

Expand Down
Loading

0 comments on commit 0cc7038

Please sign in to comment.