Commit Graph

17 Commits

Author SHA1 Message Date
Shahed Nasser
8958760d5b docs: fixes to Digital Product recipe (#7025) 2024-04-15 09:32:07 +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
Shahed Nasser
8cb53da34e docs: fix medusa-react guide + specify react-query version (#5918)
* docs: fix medusa-react guide by adding missing link

* fix link

* add v4.22 as the supported version of react-query
2023-12-18 16:01:24 +02:00
Shahed Nasser
525ae6d728 docs: added missing service method in digital products recipe (#5899)
* docs: added missing service method in digital products recipe

* fix lint
2023-12-15 15:40:05 +02:00
Shahed Nasser
11b1a61969 docs: fixes to digital products recipe (#5897)
* docs: fixes to digital products recipe

* fix lint errors
2023-12-15 12:39:40 +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
c808317044 docs: added "Integrate Your Ecommerce Stack" recipe (#5774) 2023-11-30 11:27:09 +00:00
Shahed Nasser
547b16ead5 docs: fix code block titles (#5733)
* docs: fix code block titles

* remove console

* fix build error
2023-11-27 16:08:10 +00:00
Shahed Nasser
9c7f95c3d5 docs: documentation for v1.18 (#5652)
* docs: documentation for v.17.5

* fix links

* updated version number
2023-11-21 08:57:11 +00:00
Shahed Nasser
c6dff873de docs: update docusaurus to v3 (#5625)
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
2023-11-13 20:11:50 +02:00
Shahed Nasser
0c9216c225 docs: add missing mime_type in digital products recipe (#5569)
* docs: add missing mime_type in digital products recipe

* fix lint error
2023-11-06 14:35:23 +02:00
Shahed Nasser
1a10822cae docs: update override price selection strategy documentation (#5438)
* docs: update override price selection strategy documentation

* fix eslint errors
2023-10-20 20:17:45 +03:00
Shahed Nasser
c28935b4e8 docs: update endpoints to use file-routing approach (#5397)
- Move the original guides for creating endpoints and middlewares to sub-sections in the Endpoints category.
- Replace existing guides for endpoints and middlewares with the new approach.
- Update all endpoints-related snippets across docs to use this new approach.
2023-10-19 15:56:26 +00:00
Shahed Nasser
ef3d735113 docs: update price list's user guide (#5323)
* docs: update price list's user guide

* remove import links

* hide import prices docs

* add double quotes

* fix build error

* removed import prices section

* remove text about import
2023-10-09 17:31:32 +03:00
Shahed Nasser
6d9c0eb70b docs: fix usage of non-existing repository in digital products recipe (#5280)
* docs: fix usage of non-existing repository in digital products recipe

* fix content linting
2023-10-04 11:05:23 +03:00
Shahed Nasser
70484b4cd4 docs: add Next.js steps to digital product recipe (#5231)
* docs: add Next.js steps to digital product recipe

* fix eslint errors
2023-09-27 20:32:10 +03:00
Shahed Nasser
fa7c94b4cc docs: create docs workspace (#5174)
* docs: migrate ui docs to docs universe

* created yarn workspace

* added eslint and tsconfig configurations

* fix eslint configurations

* fixed eslint configurations

* shared tailwind configurations

* added shared ui package

* added more shared components

* migrating more components

* made details components shared

* move InlineCode component

* moved InputText

* moved Loading component

* Moved Modal component

* moved Select components

* Moved Tooltip component

* moved Search components

* moved ColorMode provider

* Moved Notification components and providers

* used icons package

* use UI colors in api-reference

* moved Navbar component

* used Navbar and Search in UI docs

* added Feedback to UI docs

* general enhancements

* fix color mode

* added copy colors file from ui-preset

* added features and enhancements to UI docs

* move Sidebar component and provider

* general fixes and preparations for deployment

* update docusaurus version

* adjusted versions

* fix output directory

* remove rootDirectory property

* fix yarn.lock

* moved code component

* added vale for all docs MD and MDX

* fix tests

* fix vale error

* fix deployment errors

* change ignore commands

* add output directory

* fix docs test

* general fixes

* content fixes

* fix announcement script

* added changeset

* fix vale checks

* added nofilter option

* fix vale error
2023-09-21 20:57:15 +03:00