Shahed Nasser
00052b9e50
docs: track code copy + AI assistant event ( #14193 )
...
* docs: track code copy + AI assistant event
* add pathname to callback
2025-12-02 17:24:31 +02:00
Shahed Nasser
6ea97443de
docs: improved analytics and tracking ( #13671 )
...
* docs: improved analytics and tracking
* remove detailed feedback component
* remove ignore build script for api reference
* improvements
* fix pathname
2025-10-03 13:33:48 +03:00
Shahed Nasser
d510639193
docs: docs for next release ( #13303 )
...
* added draft order plugin docs
* fix vale error
* added note about draft order being optional
* add new shipping option - shipping method link
* update user guides
* generate
* fix github icon
* changes to shipping option type
* document logger
* reorder list
* fixes
* fixes
2025-08-28 18:49:07 +03:00
Shahed Nasser
522fc12d7a
docs: change from detecting version to since tag ( #13127 )
...
* update everything from version to since
* update events
* regenerate oas
2025-08-01 18:22:42 +03:00
Shahed Nasser
93cf79cb0f
docs: add loyalty plugin routes to OAS ( #12811 )
...
* generated OAS
* remove unused schemas
* generated specs
* add cloud badge for routes
* add to loyalty plugin page
* allow clicking the tooltip
2025-06-24 19:17:55 +03:00
Shahed Nasser
30e620a43c
docs: support deprecated in API reference ( #12438 )
2025-05-12 09:10:35 +03:00
Shahed Nasser
68bf05d220
docs: support showing version of API route in API reference ( #12433 )
...
* docs: support showing version of API route in API reference
* small design fix
2025-05-09 17:37:10 +03:00
Shahed Nasser
f81eb51b67
docs: add copy subscriber button ( #12405 )
...
* docs: add copy subscriber button
* re-generate
* fixes + update copy button
2025-05-08 12:48:44 +03:00
Shahed Nasser
262064fe96
docs: show events emitted in an API route in the API reference ( #12392 )
...
* docs: show events emitted in an API route in the API reference
* fix build error
* support version tag
* add missing property
2025-05-07 14:56:54 +03:00
Shahed Nasser
5a1f2db542
docs: added a routes summary section in API reference ( #12035 )
...
* docs: added routes summary
* added sorting
2025-03-28 19:29:57 +02:00
Shahed Nasser
9c90a39f1c
docs: sort API reference sidebar items and sections ( #12032 )
2025-03-28 17:19:28 +02:00
Shahed Nasser
9ead47c51e
docs: add prepare script to generate sidebar ( #11894 )
2025-03-18 17:37:51 +02:00
Shahed Nasser
5deb8eaf50
docs: support multiple sidebars in a project ( #11768 )
...
* changed to new sidebar across projects except resources
* finalize multi sidebar support
* clean up
* remove redundant property
* small changes
* fixes
* generate
* fix error
* fix initial open
2025-03-07 15:47:38 +02:00
Shahed Nasser
c2e24b6cfd
docs: update OAS of reset password routes ( #11711 )
2025-03-04 13:28:41 +02:00
Shahed Nasser
5634a4762b
docs: improve AI Assistant ( #11208 )
...
* initial implementation
* integrate new ai assistant in other projects + ux improvements
* fix chat window on mobile devices
* fixes to mobile
* allow pre
* change shortcut to i
* improved responsiveness
* align version in navbar
2025-01-29 19:13:51 +02:00
Shahed Nasser
a37a9c8023
docs: fix sidebar navigation in API reference ( #11179 )
2025-01-28 09:02:53 +02:00
Shahed Nasser
8038a917ee
docs: fix sidebar items not showing if they have same title in API reference ( #11122 )
2025-01-24 18:54:21 +02: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
a126f40bbe
docs: DX improvements to a workflow / step reference page ( #10906 )
2025-01-10 13:47:08 +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
91ebf6d61c
docs-util: add publishable api key header parameter to store routes OAS ( #10747 )
...
* docs-util: add publishable api key header parameter to store routes OAS
* fix oas
2024-12-26 16:27:55 +02:00
Shahed Nasser
a1738f823c
docs: change report issue link ( #10160 )
2024-11-19 15:54:16 +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
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
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
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
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
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
07afa8fba6
docs: fix how api reference shows any type ( #9340 )
2024-10-02 10:27:21 +03:00
Shahed Nasser
6a2a105cf8
fix(oas): support additional props, fix circular references patch, and other fixes ( #9213 )
...
* chore(oas): support additional props, fix circular references patch, and other fixes
* fix description
* description fixes
2024-09-20 17:22:19 +03:00
Shahed Nasser
e1fd448cd1
docs: capitalize HTTP methods in api reference ( #8821 )
2024-08-28 15:44:42 +03:00
Shahed Nasser
bfded6c2c8
docs: improvements to base OAS ( #8835 )
...
* docs: improve base OAS
* extra new lines + design fixes
2024-08-28 15:44:05 +03:00
Shahed Nasser
2f0166901f
docs: fix response code snippet in api reference ( #8689 )
2024-08-21 11:52:22 +02:00
Shahed Nasser
9734ad1e51
docs: fix category not opening in api reference from algolia search ( #8690 )
2024-08-21 11:52:13 +02:00
Shahed Nasser
f00e61707c
docs: update colors and typography ( #8604 )
2024-08-16 09:28:16 +03:00
Shahed Nasser
47eb19ca5d
docs: add associated workflow badge in api reference ( #8613 )
2024-08-16 09:26:04 +03: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
041019b319
docs: merge allOf in OAS to show all object types ( #8453 )
...
* docs: merge allOf in OAS to show all object types
* add case for non objects
2024-08-06 09:57:09 +03:00
Shahed Nasser
2682e2e324
docs: fix sidebar not updating when api reference path changes ( #8409 )
2024-08-05 13:20:53 +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
92dd855290
docs: restructure api-reference to allow base path ( #7954 )
2024-07-04 16:12:02 +00:00
Shahed Nasser
1acbcf612e
docs: fix api-reference with proxy ( #7952 )
2024-07-04 17:10:48 +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
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
98615c388b
docs-util: fixes to base OAS + circular-patch redocly plugin ( #7382 )
...
* docs-util: remove MultipleErrors schema from base OAS
* fixes to circular patch plugin
* general fixes
* change nested schemas to references
2024-05-27 14:29:48 +02:00