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/usage.md
+3 -3
View File
@@ -88,7 +88,7 @@ The following data is being collected on your admin:
### How to Enable Anonymization
To enable anonymization of your data from the Medusa admin:
To enable anonymization of your data from the Medusa Admin:
1. Go to Settings → Personal Information.
2. In the Usage insights section, click on the “Edit preferences” button.
@@ -97,7 +97,7 @@ To enable anonymization of your data from the Medusa admin:
### How to Opt-Out
There are two ways to opt out of analytics collected in the Medusa admin:
There are two ways to opt out of analytics collected in the Medusa Admin:
1. Disable the feature flag that is enabled by default for the admin analytics feature:
@@ -105,7 +105,7 @@ There are two ways to opt out of analytics collected in the Medusa admin:
MEDUSA_FF_ANALYTICS=false
```
2\. Alternatively, on your Medusa admin, you can disable tracking by following these steps:
2\. Alternatively, on your Medusa Admin, you can disable tracking by following these steps:
1. Go to Settings → Personal Information.
2. In the Usage insights section, click on the “Edit preferences” button.