chore: reorganize docs apps (#7228)

* reorganize docs apps

* add README

* fix directory

* add condition for old docs
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-05-03 17:36:38 +03:00
1 parent 224ebb2154
commit 4fe28f5a95
6187 files changed
+601447 -598226

No files matched your search

@@ -0,0 +1,64 @@
---
sidebar_position: 1
---
import { getOsShortcut } from "docs-ui"
export const metadata = {
title: `Bulk Editor`,
}
# {metadata.title}
In this document, you'll learn about different tips and shortcuts to using the bulk editor.
## Overview
The bulk editor allows you to edit prices or values using a spreadsheet-interface. It simplifies the editing process when working with a large number of data, and provides you with an intuitive user experience.
The bulk editor is used in different areas of the Medusa Admin.
{/* TODO do we still need this next section? */}
{/* ---
## Toggle Columns View
As the bulk editor may include a large number of columns, such as the different currencies supported in your store, you can toggle the columns' visibility to focus on a subset of columns.
To do that:
1. Click on the "View" button at the top left.
2. Check or uncheck a column by clicking on it in the dropdown. */}
---
## Selecting Cells
You can select multiple cells to apply an action on them. To do that:
1. Click and hold the mouse on a cell
2. Drag the mouse in the direction of the other cells you want to select.
3. Once you're done selecting, release the hold.
---
## Editing Cells
There are multiple ways you can edit cells in a bulk editor:
1. To edit the value, click the cell, then enter your new value.
3. To apply a value of a cell to other adjacent cells:
1. Click on a cell
2. Hold and Drag the blue dot at the corner of that cell to adjacent cells you want to apply the value to.
3. Once you're done, release the hold on the blue dot.
---
## Shortcuts
You can use the following shortcuts while working with the bulk editor:
- <Kbd>tab</Kbd>: Persist the current cell's value and move focus to the next cell.
- <Kbd>backspace</Kbd>: Delete the value of the selected cell(s).
- <Kbd>{getOsShortcut()}</Kbd> + <Kbd>Z</Kbd>: Undo a change you made in the currently selected cell(s).
@@ -0,0 +1,52 @@
---
sidebar_position: 2
---
export const metadata = {
title: `Admin Languages`,
}
# {metadata.title}
{/* TODO check whether the languages here are still valid. */}
Medusa Admin comes with multi-language support. This document covers the complete list of available languages, both official and by the community.
<Note>
Can't find your language? Learn how you can contribute by translating the admin to other languages [here](!resources!/contribution-guidelines/admin-translations).
</Note>
## Official Languages
- English
- French
- Portuguese
## Community Translations
<Note>
Languages listed in this section are contributed by the Medusa community. So, their accuracy is not guaranteed. If you find problems with the translations, please [open an issue in our GitHub repository](https://github.com/medusajs/medusa/issues).
</Note>
- Bosanski
- Deutsch
- Español
- Hindi
- Hrvatski
- Italiano
- 한국어
- 日本語
- Polski
- Русский
- Slovenščina
- Tamil
- Tiếng Việt
- Українська
- العربية
- Čeština
- 简体中文
- Български
@@ -0,0 +1,72 @@
---
sidebar_position: 3
---
import { XMark } from "@medusajs/icons"
export const metadata = {
title: `Lists`,
}
# {metadata.title}
In this document, you’ll get an overview of lists in Medusa including filters, searching, and more!
## Filter Items
Use filters to retrieve items in a list matching specific criteria.
{/* TODO check if the next section still applies */}
{/* ### Quick Filters
On a table with a list of items, you’ll find quick filters at the top of the list.
You can click on one of these filters to quickly apply it to the list of items.
![Quick filters for lists](https://res.cloudinary.com/dza7lstvk/image/upload/v1667998663/Medusa%20Docs/User%20Guide/eVwD0JP_ukor4r.png) */}
To do that:
1. Click on the "Add filter" button at the top of the list.
2. From the dropdown, choose the criteria you want to filter.
3. This shows a new set of values to filter the list by.
4. After selecting the value, the list only includes the items matching your filters. You can also apply multiple filters.
![Selected Filters](https://res.cloudinary.com/dza7lstvk/image/upload/v1710230676/User%20Guide/Screenshot_2024-03-12_at_10.04.20_AM_rz4xnn.png)
The filters you create are saved and are applied everytime you view the same list.
### Edit Saved Filters
To edit a saved filter:
1. Click on the filter.
2. Choose the new value of the filter.
### Delete Saved Filters
To delete any saved filter you’ve created, click the <InlineIcon Icon={XMark} alt="X" /> icon next to the filter.
### Clear Filters
To clear all applied filters, click on the "Clear all" link at the end of the list of filters.
---
## Search Items
To search for items in a list:
1. Click the search bar at the top right of the list.
2. Enter your search term. The list is updated in real-time.
![Search items in a list](https://res.cloudinary.com/dza7lstvk/image/upload/v1710233000/User%20Guide/Screenshot_2024-03-12_at_10.43.09_AM_upv15y.png)
---
## Multiple Pages
Lists in the Medusa Admin span across multiple pages if the number of items in that list are more than twenty.
Navigate between pages using the "Prev" and "Next" buttons at the bottom of the list.