Commit Graph

68 Commits

Author SHA1 Message Date
Shahed Nasser
c5d49c66a0 docs: small fixes to workflow constraints chapter (#11421)
* docs: small fixes to workflow constraints chapter

* add links to plugins in nav
2025-02-12 16:27:55 +02:00
Shahed Nasser
d348204fe5 docs: document admin environment variables (#11313) 2025-02-05 11:47:07 +02:00
Shahed Nasser
94376f6c75 docs: document Query Context (#11289)
* docs: document Query Context

* add vale exception
2025-02-03 19:43:40 +02:00
Shahed Nasser
332ef06534 docs: documet support for type aliases (#11117) 2025-01-30 09:09:29 +02:00
Shahed Nasser
c26ef84cae docs: added plugins documentation (#10989)
(Should be merged after the next release)

Closes DX-1294
2025-01-27 09:32:53 +00:00
Shahed Nasser
9462f00f8d docs: add updates documentation (#11146)
- Add chapter on updating Medusa
- Add section in UI docs about updating UI packages in standalone applications

Closes #10927
Closes DX-1282
2025-01-27 07:27:37 +00:00
Shahed Nasser
f803157943 docs: generate sidebar for main docs (#11139) 2025-01-24 19:20:02 +02:00
Shahed Nasser
cdfde0dfac docs: document workflow retention (#11138) 2025-01-24 14:34:24 +02:00
Shahed Nasser
a0e944a7a8 docs: general fixes and additions (#10876) 2025-01-08 16:09:48 +02:00
Shahed Nasser
ed9bc1f1c4 docs: revise next.js starter docs (#10520)
* docs: revised next.js starter

* update next.js starter in main docs
2024-12-10 11:58:19 +02:00
Shahed Nasser
0ae98c51eb docs: revise main docs outline (#10502) 2024-12-09 13:54:42 +02:00
Shahed Nasser
a76b533604 docs: revise last chapters of customizations (#10480) 2024-12-06 17:56:27 +02:00
Shahed Nasser
21b0e0c26b docs: revise admin customization pages (#10466)
* docs: revise admin customization pages

* fix prerequisites link

* apply lint
2024-12-06 16:34:02 +02:00
Shahed Nasser
9690e44280 docs: revise extend create product (#10444)
* docs: revise extend create product

* change sidebar title
2024-12-05 12:41:12 +02:00
Shahed Nasser
b41a4ceea8 docs: add documentation for check constraints (#10425) 2024-12-04 20:04:36 +02:00
Shahed Nasser
a943dfb529 docs: revise define brand link (#10434) 2024-12-04 19:51:28 +02:00
Shahed Nasser
51b8b39525 docs: revise extend models (features) (#10429) 2024-12-04 18:27:32 +02:00
Shahed Nasser
563b725ed6 docs: revise brand API route (#10352)
* docs: revise brand API route

* address feedback

* add directory images

* change sidebar title

* address comments
2024-12-04 12:19:42 +02:00
Shahed Nasser
aca7907d81 docs: revise create brand workflow (#10346)
* docs: revise create brand workflow

* small fix
2024-11-28 14:47:59 +02:00
Shahed Nasser
f541e21c62 docs: revise medusa container chapter (#10192) 2024-11-21 11:22:15 +02:00
Shahed Nasser
0ea57659e8 docs: improv version detection + fix breadcrumbs (#10083) 2024-11-13 18:20:05 +02:00
Shahed Nasser
6f7467f071 docs: added + updated build and deployment guides (#10019) 2024-11-13 14:44:36 +02:00
Shahed Nasser
f151fb32aa docs: add emit events + types documentation (#10026)
* docs: add emit events + types documentation

* vale fixes
2024-11-13 14:17:14 +02:00
Shahed Nasser
823552ecd9 docs: document multiple steps usage in a workflow (#10053) 2024-11-13 11:00:37 +02:00
Shahed Nasser
a131a4468d docs: improve getting started chapters (#10014) 2024-11-11 20:35:57 +02:00
Shahed Nasser
c4183a5cb7 docs: improve transform docs (#10023) 2024-11-11 19:21:53 +01:00
Shahed Nasser
df5dc65e2a docs: added documentation on environment variables (#9798) 2024-10-26 14:35:38 +00:00
Shahed Nasser
731309e87a docs: fixes following QA testing (#9690) 2024-10-22 18:20:21 +03:00
Shahed Nasser
0a37675f0e docs: add routing page (#9550)
- Add a new homepage to `book` project for the routing page
- Move all main doc pages to be under `/v2/learn` (and added redirects + fixed links across docs)
- Other: add admin components to resources dropdown + fixes to search on mobile.

Closes DX-955

Preview: https://docs-v2-git-docs-router-page-medusajs.vercel.app/v2
2024-10-18 08:24:34 +00:00
Shahed Nasser
e3dc9eaf0c docs: add guide on how to seed data (#9449)
Add a guide on how to seed data using a custom CLI script, with an example to seed products

Closes DOCS-953
2024-10-14 07:08:05 +00:00
Shahed Nasser
ed174826a4 docs: update modules chapter in basics (#9452)
* docs: update modules chapter in basics

* address PR feedback
2024-10-04 14:15:41 +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
b3a204e974 docs: document InferTypeOf (#9321)
- Add documentation on how to use InferTypeOf
- Use InferTypeOf in recipes and examples
2024-09-26 13:42:29 +00:00
Shahed Nasser
2da15ba021 docs: added architecture documentation (#9256)
* docs: added architecture documentation

* update diagrams and text

* address PR comments

* sidebar + overview fixes
2024-09-26 09:29:47 +03:00
Shahed Nasser
6584e911e0 docs: improvements + additions to workflow docs (#9182)
Improve existing workflow docs + add missing docs
2024-09-20 15:38:32 +00:00
Shahed Nasser
8dd72acee2 docs: add an examples list documentation (#9194) 2024-09-19 16:09:29 +02:00
Shahed Nasser
db73e9b972 docs: fix link in sidebar for modules test example (#9195) 2024-09-19 16:08:36 +02:00
Shahed Nasser
bf4335f2a6 docs: improvements and fixes to API route docs (#9197)
General improvements and fixes to docs around API routes
2024-09-19 14:08:23 +00:00
Shahed Nasser
0c3e3ea88a docs: customization chapter exploration (#9078)
Adds a new customizations chapter with realistic example while maintaining the linear learning journey.

Preview: https://docs-v2-git-docs-customizations-chapter-medusajs.vercel.app/v2/customization
2024-09-18 08:45:29 +00:00
Shahed Nasser
cda5bbac78 docs: added documentation on instrumentation (#9160)
Added new documentation chapter on instrumentation and observability
2024-09-17 17:22:16 +00:00
Shahed Nasser
1466ca73e0 docs: added a services constraint document (#8999)
- Added a services constraint document mentioning that a service's methods must be async.
- Modify the code in the services intro document to use `async` method.
2024-09-10 18:00:23 +00:00
Shahed Nasser
e9b5f76f9a docs: add Query documentation (#9079)
- Replace remote query documentation with new Query documentation
- Add redirect from old remote query to new query documentation
- Update remote query usages across docs to use new query usage.
2024-09-10 12:31:47 +00:00
Shahed Nasser
1d54e8fdc1 docs: add new API route guides + fixes and improvements to existing ones (#8987)
- Add new documentation pages for API route intro, responses, errors, and validation
- General fixes and improvements across existing API route guides

> Note: I didn't work on the guide for additional data validation. Will work on this as part of my next focus on workflows.
2024-09-04 18:23:55 +00: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
5996089c9c docs: added new guides and troubleshooting related to admin development (#8739) 2024-08-27 10:35:09 +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
Shahed Nasser
705ea0ad33 docs: improve the workflow hooks guide (#8538)
* initial

* docs: improve workflow hook guides
2024-08-13 09:55:37 +03:00
Shahed Nasser
e7965db071 docs: added a chapter on how to emit an event (#8414) 2024-08-05 11:39:47 +03:00
Shahed Nasser
6f973d9f2b docs: added workflow hooks docs + changed workflow response (#8364)
* docs: added workflow hooks docs + changed workflow response

* Update page.mdx
2024-07-31 17:01:33 +03:00