Commit Graph

4 Commits

Author SHA1 Message Date
Shahed Nasser
0154c0495d docs: fix tables design + update icons package (#11184) 2025-01-27 18:57:52 +02:00
Shahed Nasser
b8ba020cd5 docs: redesign tables (#8653)
* docs: redesign tables

* fixes
2024-08-20 14:47:36 +02:00
Shahed Nasser
9b1998b9b2 docs: update events reference (#7321)
* change subscribers events

* add event references for modules
2024-05-16 09:01:12 +02:00
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