asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
4,698 Commits 2 Branches 0 Tags
be8122bc0dd4232b9c2dc181f522fc54efb2631d
Commit Graph

42 Commits

Author SHA1 Message Date
Leonardo Cabeza
be8122bc0d Update redis.md (#6519) 
Fix ioredis options url
 2024-02-27 08:45:34 +00:00
Shahed Nasser
52afc619b3 docs: typo fix in create event module reference (#6470) 2024-02-22 12:16:18 +01:00
Shahed Nasser
16927469eb docs: fixes to code snippets in Workflows documentation (#6393) 2024-02-14 13:25: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
Siddharth Kulkarni
5c6ba674fb docs: update link to io-redis options (#6337) 
…ties

Update redis.md to correct the documentation link to io-redis propoerties.   Current Link was incorrect.
 2024-02-07 12:55:21 +00:00
Ira
44470bf8c5 Update all curl documentation examples and references with new x-medusa-access-token header (#6326) 
## What

This is to update incorrect documentation in regards to authentication to the Admin API - raised in https://github.com/medusajs/medusa/issues/6264.

## Why

Because the current documentation has been incorrect since the September 2023 release of [v1.17.0](https://github.com/medusajs/medusa/releases/tag/v1.17.0), which had breaking changes to API token usage.

## How

Simple search and replace. I was asked to replace occurrences under `www/apps/docs/content/` but there were also additional places where I thought references should also be updated:

- `packages/medusa/src/api/`
- `www/apps/api-reference/`

Feel free to revert them as needed.

There is also some inconsistency between the format shown in examples e.g. `<API_TOKEN>` vs `{api_token}` vs `{access_token}`.

I have kept the format the same in all cases as the original, as surrounding documentation text would not have format updated as well. I suggest maybe reviewing the documentation and keeping to a consistent format e.g. `<API_TOKEN>`.

 
## Testing 

I have not tested these changes. I would assume the `packages/medusa/src/api/` changes may need more thorough testing?
 2024-02-07 08:41:38 +00:00
Shahed Nasser
4792c55226 docs: migrate guides to TSDoc references (#6100) 2024-01-22 18:38:35 +01:00
Shahed Nasser
8c67e32d41 docs: improve admin documentation (#6117) 
- Move the admin plugin's options to the Admin Configuration documentation.
- Add a section on how to change the backend URL for both development and production.
- Fix the troubleshooting section related to port forwarding.
- General fixes.
 2024-01-22 15:48:33 +00:00
Vinh Nguyen
b61acf9312 fix(docs): update extend repository (#6140) 
- Issue ticket https://github.com/medusajs/medusa/issues/6139
- Update document how to extend repository
 2024-01-22 15:21:30 +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
Oli Juhl
cd2855182e docs: Update minimum node version requirement (#5994) 2024-01-04 13:13:41 +01:00
Minh Tu Ngo
c8f03e3a47 Update create.md (#5978) 
typo
 2024-01-02 09:09:39 +00:00
Shahed Nasser
5ef41bd86d docs: fix file name for scheduled jobs (#5972) 2023-12-28 12:07:05 +02:00
Nicklas Gellner
699c363c25 Add link to our official Plugin directory (#5931) 
Replaced the link for our awesome-Medusa-repo with a direct link to our official plugins page.

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
 2023-12-20 10:45:21 +00:00
Zarar Siddiqi
bbee9b4c53 docs: Add discount created event (#5850) 
* Emit event when discount code created.

* Documentation for discount.created event.

* add patch changeset

* Cleaner code, avoid array indexing.

* Revert "Documentation for discount.created event."

This reverts commit 9447f4a171dd55ac8a550beeb403cb7404a18df2.

* Docs for discount.created event.
 2023-12-14 15:54:31 +01:00
Sajarin M
4710c8ba7e Fix multiple typos in medusa docs (#5854) 2023-12-13 10:51:48 +00:00
Ishaq Khattana
f05c20695e docs: update local events module to fix mistyped reference to redis events module (#5835) 
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
 2023-12-11 13:12:22 +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
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
edeec07466 docs: added troubleshooting for postgres docker container (#5629) 
* docs: added troubleshooting for postgres docker container

* fix component name
 2023-11-14 12:27:38 +02: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
c7b8d060d7 docs: add note about ttl in redis cache module (#5617) 2023-11-13 10:42:52 +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
d4b8a89e66 docs: updated API Routes and Middlewares docs (#5588) 
* docs: updated API Routes and Middlewares docs

* fix eslint errors
 2023-11-10 11:00:08 +01: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
Stefanos Chalkidis
57c3a24ad3 docs(create-events-module): fixed typos (#5524) 2023-11-02 18:19:25 +00:00
Stefanos Chalkidis
febbf398ef docs(create-scheduled-job): rewrote sentence (#5525) 2023-11-02 17:36:10 +00:00
Shahed Nasser
8bb8eb530b docs: added documentation for logging (#5469) 2023-10-25 12:49:37 +03: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
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
3dada88c81 docs: fix links to create notification provider (#5380) 2023-10-16 13:20:51 +03:00
Shahed Nasser
a91fca69ac docs: added a note about typescript declaration file (#5361) 2023-10-12 11:08:25 +03:00
Shahed Nasser
2c94186c7d docs: add a note about yarn version support in Medusa Dev CLI guide (#5355) 2023-10-11 20:16:08 +03:00
Shahed Nasser
7a4c9dec49 docs: fix entity file path in Create Entity documentation (#5351) 2023-10-11 19:52:23 +03:00
Shahed Nasser
0b4e7ef9c3 docs: fix preserve-symlink command for yarn in plugin docs (#5285) 
* docs: fix preserve-symlink command for yarn in plugin docs

* added additional tab

* fix npm label
 2023-10-04 11:49:25 +03:00
Shahed Nasser
07e65f5aba docs: Improve Loaders documentation (#5205) 2023-09-25 19:03:00 +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