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

60 Commits

Author SHA1 Message Date
Shahed Nasser
a8df528c65 docs: add a need help button (#8069) 
* docs: add a need help button

* change github issue link

* responsive fixes
 2024-07-11 10:29:13 +03:00
Carlos R. L. Rodrigues
de36e2b36e chore: rename return flow (#8050) 2024-07-10 08:09:10 -03:00
Shahed Nasser
4c89f91caf docs: fix download button + other fixes (#8032) 
- Fix text of download button
- Small fix to styling on small devies
- Fix mobile sidebar items using incorrect base url
 2024-07-09 12:36:02 +00:00
Shahed Nasser
3d6b1dc7ae docs: fix page crashing when using google translate (#8009) 2024-07-08 10:24:45 +02:00
Shahed Nasser
de0a9c14ab docs: fix pagination on mobile devices (#7968) 
* docs: fix pagination on mobile devices

* fix algolia link
 2024-07-05 12:40:42 +02:00
Shahed Nasser
964927b597 docs: general fixes and improvements (#7918) 
* docs improvements and changes

* updated module definition

* modules + dml changes

* fix build

* fix vale error

* fix lint errors

* fixes to stripe docs

* fix condition

* fix condition

* fix module defintion

* fix checkout

* disable UI action

* change oas preview action

* flatten provider module options

* fix lint errors

* add module link docs

* pr comments fixes

* fix vale error

* change node engine version

* links -> linkable

* add note about database name

* small fixes

* link fixes

* fix response code in api reference

* added migrations step
 2024-07-04 17:26:03 +03:00
Shahed Nasser
6713d76db3 docs: prepare configuration (#7877) 
* update configuration

* resolve todos + remove events guides

* disable v2 docs in v1 navbar

* remove v2 from v1 mobile sidebar

* resolve build errors

* fix build errors

* fix lint errors

* fix lint
 2024-07-03 19:27:13 +03:00
Shahed Nasser
0462cc5acf docs: updates to use DML and other changes (#7834) 
- Change existing data model guides and add new ones for DML
- Change module's docs around service factory + remove guides that are now necessary
- Hide/remove all mentions of module relationships, or label them as coming soon.
- Change all data model creation snippets to use DML
- use `property` instead of `field` when referring to a data model's properties.
- Fix all snippets in commerce module guides to use new method suffix (no more main model methods)
- Rework recipes, removing/hiding a lot of sections as a lot of recipes are incomplete with the current state of DML.


### Other changes

- Highlight fixes in some guides
- Remove feature flags guide
- Fix code block styles when there are no line numbers.

### Upcoming changes in other PRs

- Re-generate commerce module references (for the updates in the method names)
- Ensure that the data model references are generated correctly for models using DML.
- (probably at a very later point) revisit recipes
 2024-06-26 07:55:59 +00:00
Shahed Nasser
85d487d90b docs: added checkout storefront guides (#7678) 
* add first guides

* added more guides

* finished payment + added stripe

* finished adding guides

* updated generated sidebar
 2024-06-12 19:46:06 +02:00
Shahed Nasser
6946814944 docs: update recipes to be based on v2 (#7516) 2024-06-09 15:18:43 +02:00
Shahed Nasser
4a6327e497 docs: make code blocks collapsible (#7606) 
* added collapsible code feature

* fixed side shadow

* fix build errors

* change design

* make code blocks collapsible
 2024-06-05 10:28:41 +03:00
Shahed Nasser
c38f6d07c2 docs: update design + colors (#7593) 
Update design and colors in docs to match those in Figma
 2024-06-04 07:41:24 +00:00
Shahed Nasser
65be42c818 docs: add integrations page (#7421) 
* add integrations page

* update payment provider docs

* use stripe icon
 2024-05-28 13:25:03 +03:00
Shahed Nasser
5d4bf83145 docs: fix code block highlighting for lines starting with spaces (#7356) 2024-05-20 09:49:52 +03:00
Shahed Nasser
22f30f54fd docs: update api-reference project for v2 (#7307) 
* remove everything v1 and make v2 default

* move main v2 rewrites to book

* move rewrites to book + other fixes
 2024-05-16 09:02:35 +02:00
Shahed Nasser
9b1998b9b2 docs: update events reference (#7321) 
* change subscribers events

* add event references for modules
 2024-05-16 09:01:12 +02:00
Shahed Nasser
1160a34f3d docs: handle Card and CardList components in cross-links plugin (#7338) 2024-05-16 09:40:42 +03:00
Shahed Nasser
70c4ffff8b docs: improve API testing feature (#7311) 2024-05-14 10:12:53 +03:00
Shahed Nasser
7cb90f8e82 docs: editing and general fixes of medusa's learning resources (#7261) 
* docs: editing and general fixes of medusa's learning resources

* fix build script

* update ui dependency

* fix build

* adjust next.js steps
 2024-05-13 18:55:11 +03:00
Shahed Nasser
803e4aad02 docs: added file module docs (#7278) 2024-05-13 18:54:59 +03:00
Shahed Nasser
728c5ee53c docs: preparations for preview (#7267) 
* configured base paths + added development banner

* fix typelist site url

* added navbar and sidebar badges

* configure algolia filters

* remove AI assistant

* remove unused imports

* change navbar text and badge

* lint fixes

* fix build error

* add to api reference rewrites

* fix build error

* fix build errors in user-guide

* fix feedback component

* add parent title to pagination

* added breadcrumbs component

* remove user-guide links

* resolve todos

* fix details about authentication

* change documentation title

* lint content
 2024-05-13 11:32:52 +03:00
Shahed Nasser
1a68f4602c feat(api-ref): show schema of a tag (#7297) 2024-05-10 21:07:35 +03:00
Shahed Nasser
327e446974 docs: general fixes and overall changes (#7258) 
* editing halfway

* edited second half

* adjust starter steps

* fix build

* typo fix
 2024-05-07 18:00:28 +02:00
Shahed Nasser
14d15df866 docs: added advanced workflows documentation (#7252) 2024-05-07 10:32:36 +03:00
Shahed Nasser
4fe28f5a95 chore: reorganize docs apps (#7228) 
* reorganize docs apps

* add README

* fix directory

* add condition for old docs
 2024-05-03 17:36:38 +03:00
Shahed Nasser
793184bf42 docs: improvements to railway deployment guide + new troubleshooting guide (#7012) 2024-04-15 09:30:31 +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
82db53c99e docs: fix search in api reference (#6578) 
* docs: fix search in api reference

* remove log messages
 2024-03-05 10:02:56 +01:00
Shahed Nasser
3b18f399c1 docs(ui): show icon tooltip on small devices (#6407) 2024-02-26 08:31:36 +01:00
github-actions[bot]
869dc751a0 chore(docs): Updated UI Reference (#6347) 
* chore(docs): Generated UI Reference

* fixed props typing + added new alert page

* updated ui dependencies

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
 2024-02-12 19:46:51 +01:00
github-actions[bot]
dfd9e7c772 chore(docs): Updated UI Reference (#6221) 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
 2024-01-29 08:20:51 +00:00
Shahed Nasser
ddc0c9dfff docs: add anchor link to reference parameters (#6194) 
- Added anchor links to items in parameter components
- Added sectionTitle prop in markdown theme

Note: Due to the second point, the change requires generating references to see the anchor links, which would result in a big diff in this PR. Instead, next time the references are generated for a release, this feature will available for use.
 2024-01-24 08:42:55 +00:00
Shahed Nasser
0b0c25da11 docs: update dependencies (#6046) 2024-01-10 10:56:54 +02:00
Shahed Nasser
97fd67bdd3 docs: improvements of docs UI (#6038) 
* docs: improvements of docs UI

* changed note about icon sizes
 2024-01-09 19:21:12 +02: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
Aldo Román
f81367f84a fix: Typo in documentation (#5933) 
Expendable -> Expandable
 2023-12-20 11:11:03 +00: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
c0ce969cd7 docs: fixed sidebar in API reference (#5871) 2023-12-14 13:26:24 +02:00
Shahed Nasser
245e5c9a69 docs: generate documentation for UI components (#5849) 
* added tool to generate spec files for React components

* use typedoc for missing descriptions and types

* improvements and fixes

* improvements

* added doc comments for half of the components

* add custom resolver + more doc comments

* added all tsdocs

* general improvements

* add specs to UI docs

* added github action

* remove unnecessary api route

* Added readme for react-docs-generator

* remove comment

* Update packages/design-system/ui/src/components/currency-input/currency-input.tsx

Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>

* remove description of aria fields + add generate script

---------

Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>
 2023-12-13 16:02:41 +02:00
Shahed Nasser
fa4935259c docs: diagrams plugin tooling (#5741) 
* added plugin

* updated plugin + added component

* dummy data TO BE REMOVED

* (wip) workflow generator tool

* add workflow generator tooling

* updated the generator tool

* added code file creation

* fix design of diagrams

* configured diagram theme

* added build script

* removed comments + unnecessary files

* general fixes

* refactored plugin

* added README + more output types
 2023-11-28 14:30:23 +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
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
2d74ec256f docs: resdesign and restructure modules references (#5372) 
* docs: change format of module reference

* description fix

* update structure + comments

* added new options to README

* small text fix

* change section ordering

* change how required/optional are shown

* remove optional text

* docs: redesigned accordion
 2023-10-16 19:51:55 +03:00
Shahed Nasser
05dbc7a877 docs: fix beta tag (#5321) 2023-10-09 14:05:55 +03:00
Shahed Nasser
b3f75d8f21 docs: add AI Assistant (#5249) 
* added components

* added ai assistant button

* change styling

* improve AI assistant

* change to a drawer

* added command support into search

* add AiAssistant to all projects

* remove usage of Text component

* added error handling

* use recaptcha

* fix new configurations

* fix background color

* change suggested questions
 2023-10-05 11:10:44 +03:00
Shahed Nasser
7016c8940c docs: fix design issues (#5252) 
* docs: fix design issues

* fix commands in installation tabs
 2023-09-29 17:17:24 +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
11b2f1237b docs: fix irregular scrolling in code tabs (#5239) 
* docs: fix blocking scroll util

* remove unnecessary util methods
 2023-09-27 19:17:04 +03:00