Commit Graph

123 Commits

Author SHA1 Message Date
github-actions[bot]
b40fa6353e chore(docs): Updated API Reference (v2) (#9552)
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-10-14 11:00:04 +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
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
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
github-actions[bot]
21badd069d chore(docs): Updated API Reference (v2) (#9437)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-03 07:48:54 +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
github-actions[bot]
1c4d3f32cb chore(docs): Updated API Reference (v2) (#9174)
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>
2024-09-18 11:30:02 +00:00
github-actions[bot]
56ee4d6aad chore(docs): Updated API Reference (v2) (#9148)
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>
2024-09-18 07:13:51 +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
35ffaf73d7 docs: update store cURL examples in OAS (#9099) 2024-09-16 15:37:11 +03:00
github-actions[bot]
cf3c25addf chore(docs): Updated API Reference (v2) (#9033)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-09-06 12:25:48 +00:00
github-actions[bot]
edc19e748b chore(docs): Updated API Reference (v2) (#8954)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-09-03 07:18:42 +00:00
github-actions[bot]
d6dcda5b8f chore(docs): Updated API Reference (v2) (#8929)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2024-09-02 07:45:24 +00:00
Shahed Nasser
0d24262bbe docs: fix missing auth tag in api reference (#8903) 2024-09-01 11:42:27 +02:00
github-actions[bot]
524be62312 chore(docs): Generated API Reference (v2) (#8890)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-08-30 08:35:10 +02:00
Shahed Nasser
8cf47516c1 docs: use new x-sidebar-summary for sidebar items in api-reference if available (#8865)
Use the new `x-sidebar-summary` OAS attribute when adding operations to the sidebar, if available.
2024-08-29 17:14:10 +00:00
Shahed Nasser
fbd93ab67c docs: fix tag filters in search (#8862) 2024-08-29 20:05:58 +03:00
github-actions[bot]
4e6e81f445 chore(docs): Updated API Reference (v2) (#8870)
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>
2024-08-29 13:05:50 +00: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
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
github-actions[bot]
cd4063de74 chore(docs): Updated API Reference (v2) (#8758)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2024-08-26 08:06:02 +00:00
Shahed Nasser
320b01f45d docs: redesign search + re-introduce ai assistant in v2 docs (#8678)
* docs: redesign search + re-introduce ai assistant in v2

* change version in ui

* show icon in case of error

* fixes based on feedback
2024-08-23 10:42:37 +03: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
github-actions[bot]
83bfad386e chore(docs): Updated API Reference (v2) (#8714)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2024-08-22 08:52:13 +00:00
Shahed Nasser
a3c311126e docs: fix algolia cron script (#8701) 2024-08-21 20:01:36 +02: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
github-actions[bot]
cc3e84f081 chore(docs): Updated API Reference (v2) (#8686)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2024-08-21 07:20:13 +00:00
Shahed Nasser
43202dde0f docs: redesign footer (#8651) 2024-08-20 14:47:53 +02:00
github-actions[bot]
cb2ead3a1c chore(docs): Generated API Reference (v2) (#8668)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-08-20 12:31:06 +02:00
Shahed Nasser
800d034c89 docs: update algolia (#8625)
Update algolia to fix issues with highlighting and snippets
2024-08-19 07:12:02 +00:00
github-actions[bot]
46310e32d0 chore(docs): Generated API Reference (v2) (#8643)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-08-18 16:55:04 +02:00
github-actions[bot]
0f67345308 chore(docs): Updated API Reference (v2) (#8619)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2024-08-16 06:46:04 +00:00
Shahed Nasser
0cc2a62b9b docs: collapse sidebar by default in main docs + persist state (#8608)
* docs: collapse sidebar by default in main docs + persist state

* persist sidebar hidden
2024-08-16 09:29:14 +03:00
Shahed Nasser
f00e61707c docs: update colors and typography (#8604) 2024-08-16 09:28:16 +03:00
Shahed Nasser
12728f17ad docs: fix scroll top margin (#8605) 2024-08-16 09:28:02 +03:00
Shahed Nasser
47eb19ca5d docs: add associated workflow badge in api reference (#8613) 2024-08-16 09:26:04 +03:00
github-actions[bot]
b23ddcdde8 chore(docs): Updated API Reference (v2) (#8609)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-08-15 14:31:35 +00:00
Shahed Nasser
b4d4b10ba5 docs: fix $lt and $gt in api reference (#8580) 2024-08-15 16:47:09 +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
35da5dedc1 docs: fix build errors + update medusa docs link (#8550)
* docs: update medusa docs link

* fix @medusajs/icon version

* fix user guide build

* fix build error
2024-08-13 08:51:20 +02: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
github-actions[bot]
31ec4d0d71 chore(docs): Updated API Reference (v2) (#8384)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2024-08-01 07:43:40 +00:00
github-actions[bot]
749e86b5d8 chore(docs): Updated API Reference (v2) (#8361)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2024-07-31 07:33:02 +00:00