github-actions[bot]
7fe164bc1d
chore(docs): Generated References ( #6904 )
...
Generated the following references:
- `inventory`
- `js_client`
- `medusa`
- `medusa_config`
- `medusa_react`
- `modules`
- `payment`
- `pricing`
- `product`
- `services`
- `stock_location`
- `tax_calculation`
- `types`
- `workflows`
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2024-04-02 10:06:06 +00:00
github-actions[bot]
68aa0971a2
chore(docs): Generated References ( #6896 )
...
Generated the following references:
- `inventory`
- `js_client`
- `medusa`
- `medusa_config`
- `medusa_react`
- `modules`
- `payment`
- `pricing`
- `product`
- `services`
- `stock_location`
- `tax_calculation`
- `types`
- `workflows`
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2024-04-01 13:35:12 +00: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
github-actions[bot]
1d0a978ffe
chore(docs): Generated References ( #6351 )
...
Generated the following references:
- `file`
- `fulfillment`
- `inventory`
- `js_client`
- `medusa`
- `medusa_config`
- `medusa_react`
- `modules`
- `notification`
- `payment`
- `price_selection`
- `pricing`
- `product`
- `services`
- `stock_location`
- `tax`
- `tax_calculation`
- `types`
- `workflows`
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2024-02-08 21:18:10 +00:00
github-actions[bot]
5a550e73b4
chore(docs): Generated References ( #6222 )
...
Generated the following references:
- `entities`
- `file`
- `fulfillment`
- `inventory`
- `js_client`
- `medusa`
- `medusa_config`
- `medusa_react`
- `modules`
- `notification`
- `payment`
- `price_selection`
- `pricing`
- `product`
- `search`
- `services`
- `stock_location`
- `tax`
- `tax_calculation`
- `types`
- `workflows`
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com >
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2024-01-25 18:12:27 +00:00
Shahed Nasser
4792c55226
docs: migrate guides to TSDoc references ( #6100 )
2024-01-22 18:38:35 +01:00
github-actions[bot]
6721633478
chore(docs): Generated References ( #6042 )
...
Generated the following references:
- `entities`
- `fulfillment`
- `inventory`
- `js_client`
- `medusa`
- `medusa_react`
- `modules`
- `payment`
- `pricing`
- `product`
- `services`
- `stock_location`
- `types`
- `workflows`
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com >
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2024-01-10 09:25:11 +00:00
Shahed Nasser
7d650771d1
docs: generate medusa-react reference ( #6004 )
...
* add new plugin for better organization
* added handling in theme for mutations and query types
* added tsdoc to hooks
* added tsdocs to utility functions
* added tsdoc to providers
* generated reference
* general fixes for generated reference
* generated api reference specs + general fixes
* add missing import react
* split utilities into different directories
* added overview page
* added link to customer authentication section
* fix lint errors
* added changeset
* fix readme
* fixed build error
* added expand fields + other sections to overview
* updated what's new section
* general refactoring
* remove unnecessary query field
* fix links
* added ignoreApi option
2024-01-05 17:03:38 +02:00
Shahed Nasser
892d737c1f
docs: enhance how references are generated ( #5805 )
...
* adjusted configurations
* enhancements to tool and configurations
* change reference in docs
* fixed issue in workflows reference
* added project name
* more optimizations
* fix context error
* added a types reference
* resolved missing types
* fix reference reflection types not having children
* add an expand url parameter
* added new option to the README
* added details about new option
2023-12-05 15:29:41 +02:00
Shahed Nasser
f802e2460f
docs: TSDoc + reference of fulfillment service ( #5761 )
2023-11-29 11:58:08 +00:00
github-actions[bot]
cdd42dbdcd
chore(docs): Generated References ( #5743 )
...
Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com >
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2023-11-27 18:58:52 +00:00
Shahed Nasser
cdc1da5df7
docs: added documentation pages for experimental features ( #5671 )
...
* docs: added documentation pages for experimental features
* fix content lint issues
* fixed lint errors
* added migration step
* added workflows introduction
* add installation guides
* added installation guides for modules + generated workflows reference
* added missing workflows reference link
* Added warning message for experimental features
* fix note
2023-11-27 16:49:12 +00:00
