Files

Shahed Nasser bb87db8342 docs: prep for v2 documentation (#6710 )

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.

2024-03-18 07:47:35 +00:00

1.8 KiB

Raw Blame History

sidebar_position, description, addHowToData

sidebar_position	description	addHowToData
2	This user guide explains how to manage user profile on the Medusa Admin. Learn how to edit a user profile and reset user password.	true

Manage Profile

In this document, you’ll learn how to manage your account including resetting your password and editing your account details.

Reset Password

To reset your password:

On the login screen, click on the “Forget your password?” link.
Enter the email of your account.
Click on the “Send reset instructions” button.
You’ll find the instructions to reset your password in the email you receive.

:::note

If you don’t receive an email, please get in touch with your technical team to ensure an email service is set up correctly.

:::

Edit Profile

To edit your profile details:

Go to Settings → Personal Information.
Click on the “Edit information” button.
In the form that opens, you can edit your personal information.
Once done, click on the “Submit and close” button.

Change Admin Language

The Medusa Admin supports multiple languages, and you can change the default language from your profile settings.

:::note

Some languages are not official, so they may not be accurate. Please refer to this document for a full list of official languages and community translations.

:::

To change the language:

Go to Settings → Personal Information.
For the Language field, select the language you want from the dropdown.
The language will be saved and changed.

Edit Analytics Preferences

To edit your analytics collection preferences:

Go to Settings → Personal Information.
Click on the “Edit preferences” button.
In the form that opens, you can edit any of the options.
Once done, click on the “Submit and close” button.

1.8 KiB Raw Blame History Unescape Escape