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
0b0c25da11
docs: update dependencies ( #6046 )
2024-01-10 10:56:54 +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
761d2e7a69
docs: update documentation websites ( #5882 )
...
* docs: update next.js to 14.0.4
* update docusaurus to v3.0.1
* update packages dependencies
* added engines
* update lock
2023-12-14 20:43:16 +02:00
Shahed Nasser
a6c8490fc3
docs: updates for v1.19 ( #5868 )
...
* docs: updates for v1.19
* Update www/apps/docs/content/upgrade-guides/medusa-core/1-19.mdx
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com >
* Update www/apps/docs/content/upgrade-guides/medusa-core/1-19.mdx
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com >
---------
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com >
2023-12-14 15:52:41 +01: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
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
2850e9a772
docs: redesigned admonitions ( #5689 )
2023-11-22 17:07:29 +00:00
Shahed Nasser
00d59e28e9
docs: redesign tabs ( #5687 )
...
* redesigned tabs
* design fixes
2023-11-22 16:01:51 +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
91615f9c45
chore: improve JS Client TSDoc comments ( #5582 )
...
* add oas schema to tsdoc parser
* add tsdoc (part 1)
* Finished tsdoc in js client
* general fixes
* added tsdoc in core medusa package
* parse schema tags in model files
* added maxlevel option
* added more tsdoc
* added tsdoc in core
* added TSDoc in core package
* generated client types
* support featureFlag and expandable tags
* added support for resource feature flag note
* fix api ignore plugin
* added eslint plugin
* support feature flag and expandable badges
* adjusted overview page + generated reference
* revert generated files
* added changeset
* add details about new typedoc options
* fix broken link
2023-11-09 12:51:17 +02:00
Shahed Nasser
7f9c4dea66
docs: improve UX of recipe learning path ( #5477 )
...
* docs: improve UX of recipe learning path
* fix icon colors
2023-10-26 16:05:17 +03:00
Shahed Nasser
f0af8ecc89
docs: generate pricing module reference ( #5349 )
...
* docs: generate pricing module reference
* added notes about new configurations
2023-10-11 14:08:19 +03:00
Shahed Nasser
aecf719871
docs(ui,docs): added upgrade guides link to UI docs ( #5240 )
...
* added medusa ui index page
* remove console
2023-09-27 20:06:03 +03:00
Shahed Nasser
63aea62d7a
docs: improve tailwind configuration ( #5215 )
2023-09-26 15:08:30 +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
