Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Reknij committed May 27, 2024
1 parent 3cc80a2 commit c5b2348
Show file tree
Hide file tree
Showing 13 changed files with 129 additions and 1 deletion.
13 changes: 13 additions & 0 deletions web/docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ export default defineConfig({
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
siteTitle: 'Elerp',
logo: '/elerp_logo.svg',
search: {
provider: 'local'
}
Expand Down Expand Up @@ -37,6 +38,10 @@ export default defineConfig({
text: "Add Order",
link: '/tutorial/add-order'
},
{
text: "Check Inventory",
link: '/tutorial/check-inventory'
},
{
text: 'Admin & General User',
link: '/tutorial/user'
Expand Down Expand Up @@ -72,6 +77,10 @@ export default defineConfig({
text: "Tambah Pesanan",
link: '/ms/tutorial/add-order'
},
{
text: "Semak Inventori",
link: '/ms/tutorial/check-inventory'
},
{
text: 'Pentadbir & Pengguna Umum',
link: '/ms/tutorial/user'
Expand Down Expand Up @@ -107,6 +116,10 @@ export default defineConfig({
text: "添加订单",
link: '/zh/tutorial/add-order'
},
{
text: "检查库存",
link: '/zh/tutorial/check-inventory'
},
{
text: '管理员和普通用户',
link: '/zh/tutorial/user'
Expand Down
Binary file added web/docs/assets/inventory-example-export.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added web/docs/assets/inventory-example-filtering.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added web/docs/assets/preview_main_512.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 9 additions & 1 deletion web/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ layout: home
hero:
name: "Elerp"
text: Easily manage inventory and orders across multiple warehouses.
image:
src: /assets/preview_main_512.png
alt: Elerp(L)
tagline: Pay monthly and stop whenever you want.
actions:
- theme: brand
Expand All @@ -27,6 +30,11 @@ features:
details: Check out your top 10 most popular products by sales and their total sales!
---

# Preview
## Preview
### Home page
<img style="margin: 5px auto" src="./assets/preview1.png">

---

### Statistical
<img style="margin: 5px auto" src="./assets/preview2.png">
11 changes: 11 additions & 0 deletions web/docs/ms/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ hero:
name: "Elerp"
text: Urus inventori dan pesanan dengan mudah merentas berbilang gudang.
tagline: Bayar setiap bulan dan hentikan bila-bila masa anda mahu.
image:
src: /assets/preview_main_512.png
alt: Elerp(L)
actions:
- theme: brand
text: Tutorial
Expand All @@ -27,3 +30,11 @@ features:
details: Lihat 10 produk paling popular anda mengikut jualan dan jumlah jualannya!
---

## Pratonton
### Laman utama
<img style="margin: 5px auto" src="../assets/preview1.png">

---

### Statistik
<img style="margin: 5px auto" src="../assets/preview2.png">
28 changes: 28 additions & 0 deletions web/docs/ms/tutorial/check-inventory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Semak inventori
## Penapisan
Anda boleh menyemak keputusan dengan menapis. Sebagai contoh, anda ingin menyemak inventori gudang `KL` dan hanya menyemak produk dengan kategori SKU `Minuman` dan kurang daripada `450`. Anda boleh melakukan ini:

![Contoh 1](../../assets/inventory-example-filtering.png)

Kemudian klik `Tapis` untuk mendapatkan keputusan.

## Menyusun
Anda boleh menyemak keputusan dengan mengisih. Contohnya, jika anda ingin mengisih mengikut kuantiti dalam tertib menaik, klik lajur `Kuantiti`:
::: tip Tidak ditetapkan, lalai
![Isih contoh](../../assets/inventory-example-sorting-unset.png)
:::

::: tip Tertib menaik
![Isih contoh](../../assets/inventory-example-sorting-ascending.png)
:::

::: tip Susunan menurun
![Isih contoh](../../assets/inventory-example-sorting-descending.png)
:::

## Eksport
Anda boleh mengeksport hasil inventori ke fail `xlsx`. Hasilnya ialah sokongan untuk penapisan dan pengisihan.

Untuk melakukan ini, klik butang `Eksport`.

![Butang eksport](../../assets/inventory-example-export.png)
28 changes: 28 additions & 0 deletions web/docs/tutorial/check-inventory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Check the inventory
## Filtering
You can check the results by filtering. For example, you want to check the inventory of warehouse `KL` and only check products with SKU category `Beverages` and less than `450`. You can do this:

![Example 1](../assets/inventory-example-filtering.png)

Then click `Filter` to get the results.

## Sorting
You can check the results by sorting. For example, if you want to sort by quantity in ascending order, click the `Quantity` column:
::: tip Not set, default
![Sort example](../assets/inventory-example-sorting-unset.png)
:::

::: tip Ascending order
![Sort example](../assets/inventory-example-sorting-ascending.png)
:::

::: tip Descending order
![Sort example](../assets/inventory-example-sorting-descending.png)
:::

## Export
You can export the inventory results to an `xlsx` file. The result is support for filtering and sorting.

To do this, click the `Export` button.

![Export button](../assets/inventory-example-export.png)
12 changes: 12 additions & 0 deletions web/docs/zh/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ hero:
name: "Elerp"
text: 轻松管理多个仓库中的库存和订单。
tagline: 仅提供月度计划
image:
src: /assets/preview_main_512.png
alt: Elerp(L)
actions:
- theme: brand
text: 教程
Expand All @@ -27,3 +30,12 @@ features:
details: 轻松帮你统计前10个最热门的产品出售数量以及销售额!
---

## 预览
### 主页
<img style="margin: 5px auto" src="../assets/preview1.png">

---

### 统计
<img style="margin: 5px auto" src="../assets/preview2.png">

28 changes: 28 additions & 0 deletions web/docs/zh/tutorial/check-inventory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# 检查库存
## 筛选
您可以通过过滤来检查结果。例如,您想查询仓库`KL`的库存,只查询SKU类别`饮料`且小于`450`的产品。你可以这样做:

![Example 1](../../assets/inventory-example-filtering.png)

然后单击`筛选`即可获取结果。

## 排序
您可以通过排序来检查结果。 例如,如果您想按数量升序排序,请单击`数量`列:
::: tip 未设置,默认
![Sort example](../../assets/inventory-example-sorting-unset.png)
:::

::: tip 升序
![Sort example](../../assets/inventory-example-sorting-ascending.png)
:::

::: tip 降序
![Sort example](../../assets/inventory-example-sorting-descending.png)
:::

## 导出
您可以将清单结果导出到`xlsx`文件。 结果是支持筛选和排序。

为此,请单击`导出`按钮。

![Export button](../../assets/inventory-example-export.png)

0 comments on commit c5b2348

Please sign in to comment.