Commit Graph

128 Commits

Author SHA1 Message Date
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
c4eb36b837 docs: added note in API reference clarifying what schemas are (#11116)
* docs: added note in API reference clarifying what schemas are

* add yarn lock
2025-01-23 17:02:25 +02:00
Shahed Nasser
0d18d5854a docs: fixes for core workflows reference (#11056)
* docs: fix step input / output description not showing

* fix generated example for array types

* show workflow summary in diagram

* fix workflow node width

* hide undefined types
2025-01-20 17:34:02 +02:00
Shahed Nasser
af350c3a8b docs: add search to workflows reference (#11054)
* docs: add search to workflows reference

* fix error
2025-01-20 17:02:29 +02:00
Shahed Nasser
cbcca219e2 docs: fix select code blocks in UI docs (#11010) 2025-01-17 15:20:58 +02:00
Shahed Nasser
cf62a0a43c docs: handle step tooltip bug in safari (#10954) 2025-01-14 12:08:59 +02:00
Shahed Nasser
a126f40bbe docs: DX improvements to a workflow / step reference page (#10906) 2025-01-10 13:47:08 +02:00
Shahed Nasser
44706ef03b docs: add workflow and js sdk reference pages for commerce modules (#10898)
* docs: add workflow and js sdk reference pages for commerce modules

* resolve build errors
2025-01-09 18:19:40 +02:00
Shahed Nasser
46f987e351 docs-util: fix parsing when function if it has three parameters (#10878)
* docs-util: fix parsing when step when it has three parameters

* fix condition
2025-01-08 16:48:20 +02:00
Shahed Nasser
936954e0b4 docs: fix divider in API reference + clean up layout (#10861)
* docs: fix divider in API reference + clean up layout

* fix build error
2025-01-07 14:59:39 +02:00
Shahed Nasser
a0a94d5030 docs: fix code tabs in production (#10784) 2024-12-31 16:08:04 +02:00
ahrbil
0e2f608db8 docs: update desktop nav menu item title (#10125)
Update menu item title to reflect current state of the desktop sidebar
2024-12-31 11:05:00 +02:00
Shahed Nasser
1c355dac36 docs: update and fix UI props docs (#10754) 2024-12-27 14:53:46 +02:00
Shahed Nasser
ee50e67a96 docs: add JS SDK to commerce modules sidebars (#10740) 2024-12-26 13:33:33 +02:00
Shahed Nasser
ebca8fed28 docs: revise commerce modules overview pages (#10738)
* revise API Key Module overview

* revise auth module

* support ref sidebar items

* remove examples

* revise cart module

* revise currency

* revise customer module

* revise fulfillment module

* revise inventory module

* revise order module

* revise payment

* revise pricing module

* revise product module

* revise promotion module

* revise region module

* revise sales channel module

* revise stock location module

* revise store module

* revise tax module

* revise user module

* lint content + fix snippets
2024-12-26 10:32:16 +02:00
Shahed Nasser
be9b19eb0f docs: split commerce modules sidebars (#10705) 2024-12-23 18:09:53 +02:00
Shahed Nasser
cccce65ef9 docs: fix bugs in API reference (#10557) 2024-12-11 18:32:58 +02:00
Shahed Nasser
e41ab50f59 docs: added restock notification guide (#10413)
* docs: added restock notification guide

* changes

* lint fixes

* fixes

* more changes

* remove get email step

* add og image

* update sendRestockNotificationsWorkflow

* updates

* fix links
2024-12-10 16:50:40 +02:00
Shahed Nasser
096f1c2a9b docs: revise storefront development guide (#10522) 2024-12-10 12:33:52 +02:00
Shahed Nasser
b4d6a4b3f0 docs: intro + basic chapter fixes (#10361) 2024-12-02 09:31:47 +02:00
Shahed Nasser
78e68a0bb6 docs: fix base path not added to hash links (#10235) 2024-11-22 18:42:49 +02:00
Shahed Nasser
c99b03bcc2 docs: change logo (#10208)
* docs: changed logo

* remove unused component
2024-11-21 18:15:32 +02:00
Shahed Nasser
35afa04a93 docs: migrate Kapa (#10198)
* docs: migrate kapa

* remove unused dependency

* fix isbrowser
2024-11-21 15:05:50 +02:00
Shahed Nasser
7a3c6acf31 docs: fix heading import in ui route docs (#10167) 2024-11-19 18:49:07 +02:00
Shahed Nasser
a1738f823c docs: change report issue link (#10160) 2024-11-19 15:54:16 +02:00
Shahed Nasser
3b1463048a docs: fix error on collapsing prerequisites (#10153) 2024-11-19 13:35:47 +02:00
Shahed Nasser
b0c6efa98b docs: fix copy in code blocks with tabs (#10123)
* docs: fix copy in code blocks with tabs

* fix lint error
2024-11-15 18:59:46 +02:00
Shahed Nasser
273960f6e3 docs: fix client error for learning path (#10102) 2024-11-14 16:53:24 +02:00
Shahed Nasser
0ea57659e8 docs: improv version detection + fix breadcrumbs (#10083) 2024-11-13 18:20:05 +02:00
Shahed Nasser
662b096a46 docs: fix oneOf design hiding more than three items (#10077)
* docs: fix oneOf design hiding more than three items

* fix lint errors

* fix eslint
2024-11-13 17:41:49 +02:00
Shahed Nasser
938f3bd934 docs: update to next 15 + eslint 9 (#9839)
* update next

* updated react

* update eslint

* finish updating eslint

* fix content lint errors

* fix docs test

* fix vale action

* fix installation errors
2024-11-13 17:03:17 +02:00
Shahed Nasser
1d87459951 docs: remove duplicate buttons in code actions (#10061) 2024-11-13 10:59:14 +02:00
Shahed Nasser
88f2d17a24 docs: change configurations to make v2 the main docs (#9729)
* docs: change configurations to make v2 the main docs

* move api routes to top level

* remove api prefix

* update opengraph images

* show v1 link

* add redirect to v1
2024-10-24 14:49:58 +03:00
Shahed Nasser
04cec64fa1 docs: show latest version in docs + update automatically (#9753) 2024-10-24 14:03:34 +03:00
Shahed Nasser
c08df5ac44 docs: remove dev notices + fix AI assistant answer width (#9686)
* docs: remove dev notices + fix AI assistant answer width

* fix import

* more notes removal

* rc to latest
2024-10-23 09:52:52 +02:00
Shahed Nasser
8891c0a3d0 docs: remove v1 docs from navbar (#9722)
* docs: remove v1 docs from navbar

* remove fallback
2024-10-23 09:10:27 +02:00
Shahed Nasser
a1190b7208 docs: generate + configure js sdk reference (#9714)
Manually generate the JS SDK reference + add it to the sidebar
2024-10-22 17:31:32 +00:00
Shahed Nasser
b2122c4073 docs: fixes and refactoring for API reference (#9708)
* docs: fixes and refactoring for API reference

* add route caching

* remove caching

* use next cache
2024-10-22 18:20:06 +03:00
Shahed Nasser
7b147aa651 docs: update nav items (#9709) 2024-10-22 18:08:45 +03:00
Shahed Nasser
b4855825be docs: fix scroll + divider issues (#9663) 2024-10-21 09:54:05 +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
49a91fd40e docs: redesigned navigation (#9525)
Redesign navigation bar to reflect new design and allow for dropdowns

Closes DX-943
2024-10-11 07:10:00 +00:00
Shahed Nasser
7f1f075222 docs: improvements and fixes to components in API reference (#9410)
- Change layout of parameters for clearer display
- Fix schema code blocks being longer than container
- switch between showing required to showing optional indicator
- Fixed code tabs not having copy / report buttons

Closes DOCS-936

Preview: https://api-reference-v2-git-docs-api-ref-comp-improv-medusajs.vercel.app/v2/api/store
2024-10-09 17:51:27 +00:00
Shahed Nasser
522d3ce764 docs: improvements to API reference intro sections (#9397)
- Improve intro sections of API reference to utilize divided columns
- Improve the content of the intro sections
- Add a new Workflows section to explain the workflows badge and how to use it
- Fixes to headings and add anchor for copying the link to a section
- Fixes responsiveness of intro sections on mobile devices
- Other: fix loading not showing when a sidebar category is opened.

Closes DOCS-932, DOCS-934, DOCS-937

Preview: https://api-reference-v2-git-docs-api-ref-intro-fixes-medusajs.vercel.app/v2/api/store
2024-10-06 16:51:08 +00:00
Shahed Nasser
ab5a7ca691 docs: fix infinite scroll, update next.js, other fixes (#9441)
* update nextjs

* badge + scroll fixes
2024-10-03 14:17:33 +03:00
Shahed Nasser
0f6f56e764 docs: DX and performance improvements in API reference (#9430)
- Improve scroll behavior between active sections
- Improve lag when clicking on a sidebar item
- Refactor internal working of the `SidebarProvider` to find active items faster.
- Use Next.js's `useRouter` hook for changing the hash (since they added the option to disable scroll)
- Change `isBrowser` from a hook to a provider since it's widely used across applications.
- Other general improvements and fixes.

Closes DOCS-952
2024-10-02 15:51:02 +00:00
Shahed Nasser
c790af7834 docs: improve search to show results for all filters (#9208)
* docs: improve search to show results for all filters

* fix index ordering
2024-09-22 14:49:16 +02:00
Shahed Nasser
138523a629 docs: change navbar items + breadcrumb improvements (#9209)
- Add a new commerce module navbar item
- Rename Learning Resources to Development Resources (in navbar and across documentation content)
- Improve breadcrumbs to show categories / subcategories

Preview: https://resources-docs-git-docs-navbar-changes-medusajs.vercel.app/v2/resources
2024-09-22 12:47:35 +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
fbd93ab67c docs: fix tag filters in search (#8862) 2024-08-29 20:05:58 +03:00