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
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
ddc6cc13a0
docs: add TSDoc for payment processor + generate docs ( #5917 )
...
* added tsdocs for payment processor
* generated reference for payment processor
2023-12-18 14:02:18 +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
Sajarin M
4710c8ba7e
Fix multiple typos in medusa docs ( #5854 )
2023-12-13 10:51:48 +00: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
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
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
github-actions[bot]
39649b3552
chore(docs): Generated References ( #5602 )
...
Generated the following references:
- `pricing`
- `product`
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com >
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2023-11-10 17:31:02 +00: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
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
83f46b9b32
docs: general fixes and enhancements ( #5429 )
...
* fix #5427
* fixes #5424
* add new s3 option
* make learning path steps clickable
* remove admin demo link
* fix documentation job conditions
* update user guide images
* update commerce modules titles to match their respective pages
* change icon of discount card
* change ref to head_ref in action condition
* remove refs prefix
* fix vale action's condition
2023-10-20 13:34:40 +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
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
