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/users/index.md
+2 -2
View File
@@ -1,6 +1,6 @@
---
sidebar_position: 1
description: 'Medusa admin can be accessed more than one user. Merchants can have users added into their team to use the Medusa admin.'
description: 'Medusa Admin can be accessed more than one user. Merchants can have users added into their team to use the Medusa Admin.'
---
# Users Overview
@@ -9,7 +9,7 @@ In this document, you’ll get an overview of features related to users and team
## Overview
Only users who are part of the store’s team can access the Medusa admin. You can have more than one user in a team. Each user must have an email and password to log in.
Only users who are part of the store’s team can access the Medusa Admin. You can have more than one user in a team. Each user must have an email and password to log in.
As an admin, you can manage the users’ roles and information. You can also invite or remove users.
www/apps/docs/content/user-guide/users/profile.md
+2 -2
View File
@@ -1,6 +1,6 @@
---
sidebar_position: 2
description: 'This user guide explains how to manage user profile on the Medusa admin. Learn how to edit a user profile and reset user password.'
description: 'This user guide explains how to manage user profile on the Medusa Admin. Learn how to edit a user profile and reset user password.'
addHowToData: true
---
@@ -38,7 +38,7 @@ To edit your profile details:
## Change Admin Language
The Medusa admin supports multiple languages, and you can change the default language from your profile settings.
The Medusa Admin supports multiple languages, and you can change the default language from your profile settings.
:::note
www/apps/docs/content/user-guide/users/team.mdx
+1 -1
View File
@@ -1,6 +1,6 @@
---
sidebar_position: 3
description: 'This user guide explains how to manage the team on the Medusa admin. Learn how to invite users to your team and edit their details.'
description: 'This user guide explains how to manage the team on the Medusa Admin. Learn how to invite users to your team and edit their details.'
addHowToData: true
---