asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: prep for v2 documentation (#6710)

Browse Source 
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs).

_Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._

## Changes

- Change Medusa version in base OAS used for v2.
- Fix to docblock generator related to not catching all path parameters.
- Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules.
- Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used.
- Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment.
- Upgraded docusaurus to v3.0.1
- Added new Vale rules to ensure correct spelling of Medusa Admin and module names.
- Added new components to the `docs-ui` package that will be used in future documentation changes.
This commit is contained in:
Shahed Nasser
2024-03-18 07:47:35 +00:00
committed by GitHub
parent 56a6ec0227
commit bb87db8342
2008 changed files with 15716 additions and 10536 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/user-guide.mdx
+5 -5
View File
@@ -1,13 +1,13 @@
---
sidebar_position: 1
description: 'The user guide explains how to use the Medusa Admin for non technical users. Learn through easy steps how to use the Medusa admin to perform different operations and ecommerce tasks.'
description: 'The user guide explains how to use the Medusa Admin for non technical users. Learn through easy steps how to use the Medusa Admin to perform different operations and ecommerce tasks.'
---
import UiIcon from '@site/src/components/UiIcon';
# Welcome to Medusa’s User Guide
This user guide is intended to help users learn how they can use the Medusa admin to perform different operational and ecommerce tasks.
This user guide is intended to help users learn how they can use the Medusa Admin to perform different operational and ecommerce tasks.
![Medusa Admin Overview](https://res.cloudinary.com/dza7lstvk/image/upload/v1697793701/Medusa%20Docs/User%20Guide/Screenshot_2023-10-20_at_12.21.19_PM_lqcurg.png)
@@ -23,11 +23,11 @@ You must use your user’s email and password to log in. If you’re unsure what
## Tour of Medusa Admin
After you log into your Medusa admin, you can see a sidebar menu, a search bar at the top, some icons at the top right, and in the middle the content of the page you’re currently on.
After you log into your Medusa Admin, you can see a sidebar menu, a search bar at the top, some icons at the top right, and in the middle the content of the page you’re currently on.
### Sidebar Menu
The sidebar menu includes the main navigation of your Medusa admin. You can use it to navigate between different pages, such as Products or Orders pages.
The sidebar menu includes the main navigation of your Medusa Admin. You can use it to navigate between different pages, such as Products or Orders pages.
![Sidebar Menu](https://res.cloudinary.com/dza7lstvk/image/upload/v1697793775/Medusa%20Docs/User%20Guide/Screenshot_2023-10-20_at_12.22.43_PM_shbr0e.png)
@@ -57,7 +57,7 @@ At the top right you’ll find a <UiIcon lightIcon="https://res.cloudinary.com/d
### Change Language
The Medusa admin supports multiple-languages, with English being the default one. Check out available languages [here](./user-guide/tips/languages.md).
The Medusa Admin supports multiple-languages, with English being the default one. Check out available languages [here](./user-guide/tips/languages.md).
Learn how to change the language in [this guide](./user-guide/users/profile.md#change-admin-language).