Raiyan Sarker
9d466717f4
docs(plugin): paypal integration missing createOrder callback ( #6401 )
...
This PR adds missing information in paypal plugin docs which is crucial to its use. Previously, docs didn't mention about createOrder callback that is required by PayPal sdk to connect with backend for details like currency and amount to be charged. Medusa backend responds with required id for the PayPal sdk to use. Related to https://github.com/medusajs/nextjs-starter-medusa/issues/260#issuecomment-1944157985
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2024-04-02 08:10:35 +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
Shahed Nasser
d1f697c88e
docs: new troubleshooting guide + cors fix ( #6387 )
...
- Fixed CORS middleware to account for routes of a single path (for example, `/custom` and not just `/custom/test`).
- Added a troubleshooting guide for admin webpack errors (see issue #6375 )
2024-02-13 11:32:02 +00:00
Nicklas Gellner
2afcf1c918
docs: clarification in text ( #6361 )
...
changed from payment to fulfillment provider in the text
2024-02-12 08:20:07 +00:00
xyzones
5cabe9585f
docs: s3 The "images.domains" configuration is deprecated ( #6321 )
2024-02-06 09:57:52 +00:00
Shahed Nasser
b78ffedafb
docs: add a section on custom templates in SendGrid guide ( #6215 )
2024-01-25 16:47:08 +01:00
Shahed Nasser
bc79edfa67
docs: update strapi guide ( #6163 )
...
Update the Strapi guide to use [this community plugin](https://github.com/SGFGOV/medusa-strapi-repo )
Fixes #5152 and #5030
2024-01-23 09:31:09 +00:00
Shahed Nasser
9d7ed9dbaf
docs: rearrange sections in SendGrid guide ( #6165 )
...
Rearrange sections in the sendgrid plugin guide to show installation steps before templates reference.
2024-01-23 08:36:34 +00:00
Shahed Nasser
4792c55226
docs: migrate guides to TSDoc references ( #6100 )
2024-01-22 18:38:35 +01:00
Shahed Nasser
13f12e1953
docs: documentation updates for v1.20 ( #6031 )
...
* docs: documentation updates for v1.20
* fix stripe upgrade guide
* fixed vale error
* fix eslint errors
* change stripe environment variables to options
2024-01-09 19:07:24 +01:00
Yessica Bao
fe81a5e49a
Update meilisearch.md ( #6026 )
...
update expire date since 2024-01-01 is past
2024-01-08 17:42:41 +00: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
e63f4e6c7a
docs: fix wishlist route ( #5914 )
2023-12-18 13:47:15 +02:00
Shahed Nasser
a34fe9bfe3
docs: updated digital ocean spaces guide ( #5900 )
...
* docs: updated digital ocean spaces guide
* fix example
2023-12-15 17:25:18 +02:00
Sajarin M
4710c8ba7e
Fix multiple typos in medusa docs ( #5854 )
2023-12-13 10:51:48 +00:00
Shahed Nasser
a458cd144d
docs: update algolia plugin next.js details ( #5807 )
2023-12-05 15:49:52 +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
Chris
a418e6cebc
docs: search results template needs the product ids to fetch previews ( #5793 )
...
https://github.com/medusajs/nextjs-starter-medusa/issues/200#issuecomment-1828308192
2023-12-05 09:23:25 +00:00
Shahed Nasser
f802e2460f
docs: TSDoc + reference of fulfillment service ( #5761 )
2023-11-29 11:58:08 +00:00
Shahed Nasser
deca78f749
docs: updated next.js starter docs ( #5748 )
...
* docs: updated next.js starter docs
* fix lint errors
* added migration script
2023-11-28 09:42:28 +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
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
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
0eb56519e9
docs: improved create-medusa-app structure ( #5458 )
2023-10-24 18:29:05 +03: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
Anna Albirena
b6bea74914
docs: Update Sendgrid Plugin Documentation ( #5284 )
...
* Update sendgrid.mdx
* Update www/apps/docs/content/plugins/notifications/sendgrid.mdx
Co-authored-by: Shahed Nasser <shahednasser@gmail.com >
---------
Co-authored-by: Shahed Nasser <shahednasser@gmail.com >
2023-10-05 10:26:30 +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
8cf92cea18
docs: improve contentful plugin documentation ( #5255 )
...
* docs: improve contentful plugin documentation
* fix eslint errors
* fix styling
* add collection and type migrations
2023-09-29 21:07:31 +03:00
Shahed Nasser
92f1f1a725
docs: fix webshipper plugins array section ( #5253 )
2023-09-29 17:43:03 +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
