Commit Graph

59 Commits

Author SHA1 Message Date
Shahed Nasser
3298cd3fd2 docs: improved commerce module docs [2/n] (#9501)
Improve + add docs for commerce modules from currency to inventory

[2/n]
2024-10-09 09:53:17 +00:00
Shahed Nasser
781d0ca624 docs: added docs for reset password (#9306)
- Added to docs on implementing auth flows using the module and API routes how to update a user's password
- Added guide on how to send a notification when a password token is generated
- Added a guide on implementing reset password flow in storefront
- Added OAS for the `/update` and `/reset-password` routes + generated specs for the API reference
2024-10-07 08:04:01 +00:00
Shahed Nasser
1bb3f8b5b1 docs: add a troubleshooting guide for dist imports (#9442) 2024-10-03 14:17:48 +03:00
Shahed Nasser
8686ca9d12 docs: updates and fixes in utils + fulfillment provider changes (#9347)
* fix config + update deps

* rearrange sidebar + add to examples
2024-10-02 10:27:48 +03:00
Shahed Nasser
fb67d90b64 docs: improvements + additions to module docs (#9152)
- Split Module and Module Links to their own chapters
- Add new docs on db operations and transactions in modules, multiple services, links with custom columns, etc...
- Added a list of registered dependencies in a module container
2024-10-01 11:20:54 +00:00
Shahed Nasser
58f06be44d docs: update docs across projects following publishable API key change in store routes (#9098)
* docs: update docs across projects following publishable API key change in store routes

* rename env variable

* move subscribe route out of store
2024-09-16 16:42:08 +03:00
Shahed Nasser
4b663a4559 docs: document events reference (#9080)
- Remove old hidden reference files that document modules' events
- Add new events reference for workflow events
- Reference events reference in the main docs
2024-09-10 12:20:09 +00:00
Shahed Nasser
a5e8a55d63 docs: added storefront development guide on retrieving variant inventory details (#9032)
* docs: added storefront development guide on retrieving variant inventory details

* fix vale error
2024-09-09 10:02:59 +03:00
Shahed Nasser
a28c911c24 docs: update auth docs + add new storefront guides (#9020)
* docs: update auth docs + add new storefront guides

* lint content

* fix vale error

* add callback response schema

* Update www/apps/resources/app/commerce-modules/auth/auth-providers/github/page.mdx

Co-authored-by: Stevche Radevski <sradevski@live.com>

* Update www/apps/resources/app/commerce-modules/auth/auth-providers/github/page.mdx

Co-authored-by: Stevche Radevski <sradevski@live.com>

* Update www/apps/resources/app/commerce-modules/auth/authentication-route/page.mdx

Co-authored-by: Stevche Radevski <sradevski@live.com>

* address PR comments

* replace google -> github

* better explanation for refresh token

---------

Co-authored-by: Stevche Radevski <sradevski@live.com>
2024-09-06 15:26:10 +03:00
Shahed Nasser
58f297cc75 docs: added documentation on testing tools (#8939)
- Added documentation on how to use Medusa's tools from the `medusa-test-utils` package to create integration and unit tests.
- Added a manual reference on the `medusaIntegrationTestRunner` and `moduleIntegrationTestRunner` functions. Since the typings in the source code aren't very informative, I opted for a manual reference shedding light on the important bits.

Closes DOCS-852
2024-09-03 14:50:45 +00:00
Shahed Nasser
c8f951dd89 docs: fixes and improvements to auth flow documentation (#8909) 2024-08-30 20:14:16 +03:00
Shahed Nasser
84fb9d55f3 docs: incorrect link fixes (#8868)
Few link fixes

Closes #8856
2024-08-29 09:44:55 +00:00
Shahed Nasser
ddddd4303c docs: add restaurant-delivery marketplace recipe (#8817)
Add recipe for restaurant-delivery marketplace recipe inspired by Medusa Eats

Closes DOCS-921

Preview: https://resources-docs-git-docs-restaurant-delivery-recipe-medusajs.vercel.app/v2/resources/recipes/marketplace/examples/restaurant-delivery
2024-08-29 09:33:31 +00:00
Shahed Nasser
70f2290a22 docs: added documentation for db commands (#8846)
* docs: added documentation for db commands

* fix lint errors
2024-08-29 10:46:00 +03:00
Shahed Nasser
0c4f4c8a11 docs: updates following authentication flow changes (#8706)
* docs: updates following authentication flow changes

* generate sidebar

* added open api specs

* fix up OAS

* changes to existing pages

* change sidebar items

* update marketplace recipe
2024-08-27 15:47:39 +03:00
Shahed Nasser
5996089c9c docs: added new guides and troubleshooting related to admin development (#8739) 2024-08-27 10:35:09 +02:00
Shahed Nasser
c63a08fb03 docs: second round of polishing (#8724)
* docs: second round of polishing

* fix overflowing width
2024-08-23 10:42:23 +03:00
Shahed Nasser
810debc7bb docs: add a note about installing preview version (#8648)
- Add a note about ensuring a package's version is set to `preview` in `package.json`
- Add a troubleshooting guide for deployments with a section about preview versions
- Added a troubleshooting section to the railway deployment guide about preview versions

Closes #8646
Closes DOCS-913
2024-08-22 08:33:24 +00:00
Shahed Nasser
f00889fe4e docs: fix link to payment concept guide in sidebar (#8708) 2024-08-21 20:05:07 +02:00
Shahed Nasser
1020ab0b97 docs: improve main docs and resources sidebar (#8664) 2024-08-20 12:31:50 +02:00
Shahed Nasser
b4f3b8a79d docs: redesign sidebar (#8408)
* initial changes

* redesign the sidebar + nav drawer

* changes to sidebar items

* finish up sidebar redesign

* support new sidebar in resources

* general fixes

* integrate in ui

* support api reference

* refactor

* integrate in user guide

* docs: fix build errors

* fix user guide build

* more refactoring

* added banner

* added bottom logo + icon

* fix up sidebar

* fix up paddings

* fix shadow bottom

* docs: add table of content (#8445)

* add toc types

* implement toc functionality

* finished toc redesign

* redesigned table of content

* mobile fixes

* truncate text in toc

* mobile fixes

* merge fixes

* implement redesign

* add hide sidebar

* add menu action item

* finish up hide sidebar design

* implement redesign in resources

* integrate in api reference

* integrate changes in ui

* fixes to api reference scrolling

* fix build error

* fix build errors

* fixes

* fixes to sidebar

* general fixes

* fix active category not closing

* fix long titles
2024-08-15 12:13:13 +03:00
github-actions[bot]
c820741df9 chore(docs): Generated References (#8583)
Generated the following references:
- `core_flows`
- `modules`
- `order`
- `types`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-08-13 13:58:28 +00:00
Shahed Nasser
d0db833817 docs: added troubleshooting for using pnpm (#8537) 2024-08-13 09:54:56 +03:00
Shahed Nasser
a19c562bec docs-util: add support for workflows in markdown theme (#8485)
* add template for workflows

* initial changes

* added support for parallel steps

* added support for when

* added merge options

* fix merge options

* fix to tooltip

* clean up

* remove redirects

* fixes

* theme fixes + added merge options

* generate hook examples + fixes

* changed namespaces

* add custom autogenerator

* change type of additional data
2024-08-09 16:35:52 +03:00
Shahed Nasser
caf1bfd23b docs: fixes to notification and file module guides (#8451) 2024-08-06 09:59:46 +03:00
Shahed Nasser
4d99cd5e28 docs: fix recipes sidebar + homepage cards (#8415) 2024-08-02 16:31:17 +03:00
Shahed Nasser
58b405fac9 docs: added digital product recipe example (#8223)
- Added an example for the digital product recipe
- Fixes to the digital product recipe (overview)

Closes DOCS-792
2024-08-02 13:02:06 +00:00
Shahed Nasser
c4ff8c27f0 docs: added subscription recipe example (#8148)
* docs: added subscription recipe

* fixed lint errors

* pass context and container to workflow

* rename context

* fix storefront customizations

* remove container from object

* updates based on latest changes

* fix workflow return

* general fixes
2024-08-02 12:40:26 +03:00
Shahed Nasser
22a629670b docs: add sidebar item for helper reference + examples fix (#8365) 2024-07-31 17:28:42 +03:00
Shahed Nasser
70d48a91b3 docs: added storefront guide on prices with taxes (#8326) 2024-07-30 12:52:21 +03:00
Shahed Nasser
a4eab3f37a docs: added a service factory reference (#8292)
Added a service factory reference of the generated methods and how to use them.

Since the types in the codebase are a bit complex, a generated reference won't provide a valuable result.

Instead, this reference is created manually and aims to cover common use cases, providing examples for them.

Closes DOCS-844
2024-07-26 14:40:56 +00:00
Shahed Nasser
157fa3c80f docs: remove js client and medusa react references (#8270) 2024-07-26 10:11:37 +03:00
Shahed Nasser
ebd290b531 docs: added guide on how to get product variant prices (#8282) 2024-07-26 10:09:41 +03:00
Shahed Nasser
0c682b92c4 docs: updates to Medusa server deployment guides (#8268)
* updated railway deployment docs

* general updates and fixes
2024-07-25 09:55:22 +03:00
Shahed Nasser
e0c0a86264 docs: added tax-inclusive conceptual guide and updates to storefront guide (#8186)
* docs: added tax-inclusive conceptual guide and updates to storefront guide

* sentence fix

* currency_code -> country_code
2024-07-18 19:03:37 +02:00
Shahed Nasser
78f49286d0 docs: updated marketplace recipe + added example (#8061)
- Moved recipes into its own section of the learning resources
- Updated the marketplace recipe overview
- Added an example implementation of the marketplace recipe

Closes DOCS-791
2024-07-11 15:56:41 +00:00
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
Shahed Nasser
3e4a96a31c docs: update order module's conceptual guides (#7893)
* fixes + add return document

* update order conceptual guides

* resolve todo

* re-generate files map
2024-07-09 18:14:30 +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
dd864da4e0 generate references (#7882) 2024-07-01 16:02:36 +03:00
Shahed Nasser
1f360a3245 docs-util: support models implemented with DML in typedoc custom plugins (#7847)
- Support generating reference for models implemented with DML
- Support resolving and generating mermaid diagram for relations

The Currency Module was used an example so its reference is generated to showcase the work of this PR.
2024-07-01 07:34:51 +00:00
Shahed Nasser
72f7500c84 chore(docs): DML API Reference (#7863)
* added dml options

* added tsdocs + configurations
2024-07-01 10:21:56 +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
c1db40b564 docs: added customer storefront guides (#7685)
* added customer guides

* fixes to sidebar

* remove old customer registration guide

* fix build error

* generate files

* run linter
2024-06-13 12:21:54 +03: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
ee6bdd0ab0 docs: add products storefront guides (#7645)
* add tips + regions pages

* docs: added storefront regions guide

* removed storefront tips chapter from book

* added product guides

* finished price guide

* add product category pages

* more categories pages

* finished category pages

* add collections guides

* add missing next.js comment

* use useRegion hook

* added missing link
2024-06-11 19:55:56 +02:00
Shahed Nasser
f3bf8c73a3 docs: added cart storefront guides (#7662)
* docs: added cart storefront guides

* add context guides

* small fixes to the context
2024-06-11 11:56:37 +03:00
Shahed Nasser
46c5c5fe28 docs: added storefront regions guides (#7623) 2024-06-09 15:19:09 +02:00
Shahed Nasser
6946814944 docs: update recipes to be based on v2 (#7516) 2024-06-09 15:18:43 +02:00
Shahed Nasser
e472aed00f docs: new + improved auth documentation pages (#7529)
* added and improved auth docs

* add prep to generates resources action

* add module options to sidebar

* fix broken link
2024-06-09 15:18:29 +02:00