Commit Graph

105 Commits

Author SHA1 Message Date
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
f9b0605d67 docs: generate sitemaps + change search filters (#8957)
- Generate sitemaps for `book` and `resources` projects (in attempt to resolve some pages not being picked up by the crawler)
- Change the v2 search filters

> Note: will require changes to algolia's crawler + a recrawl once merged
2024-09-03 10:33:08 +00:00
Shahed Nasser
fbd93ab67c docs: fix tag filters in search (#8862) 2024-08-29 20:05:58 +03:00
Shahed Nasser
870a863503 docs: fix overflowing card description hidden (#8871) 2024-08-29 19:48:48 +03: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
22d92aa70a docs: add tracking for navigation usage (#8819) 2024-08-28 15:44:54 +03:00
Shahed Nasser
b36e2c3129 docs: update create payment collection route usage in store development (#8736) 2024-08-27 10:35:22 +02:00
Shahed Nasser
b23f0f8188 docs: change notes across docs based on redesign (#8662)
Change the prerequisites / soon / other notes based on latest redesign

Depends on #8661
2024-08-23 07:59:48 +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
Shahed Nasser
0acd94aac3 docs: refactor medusa workflows reference (#8692)
* docs: fix handling of namespaces in core flows under definitions directory

* change nested handling

* docs-util: expand workflows under definitions in workflows reference

* remove check for definitions
2024-08-22 13:39:52 +03:00
Shahed Nasser
b6f990c017 docs: design polish (#8696)
* polish

* finish polish

* change typography
2024-08-21 20:04:43 +02:00
Shahed Nasser
f3e4b7dfd0 docs: fix tooltip placement and width in workflows reference (#8691) 2024-08-21 17:49:24 +03:00
Shahed Nasser
64283d0e83 docs: redesign API runner (#8688)
* fix up block style + plain theme color

* initial redesign

* docs: redesign API Runner

* revert yarn.lock changes
2024-08-21 17:48:16 +03:00
Shahed Nasser
1e07ab1b8d docs: fix broken pages due to remark plugin (#8694)
* docs: fix broken pages due to remark plugin

* refactor condition

* Update component-link-fixer.ts
2024-08-21 15:29:46 +03: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
b4d8e265e3 docs: redesign cards (#8671)
* docs: redesign cards

* fix build error
2024-08-20 14:48:17 +02:00
Shahed Nasser
48fe819d9e docs: redesign vertical tabs (#8673) 2024-08-20 14:48:09 +02:00
Shahed Nasser
43202dde0f docs: redesign footer (#8651) 2024-08-20 14:47:53 +02:00
Shahed Nasser
b8ba020cd5 docs: redesign tables (#8653)
* docs: redesign tables

* fixes
2024-08-20 14:47:36 +02:00
Shahed Nasser
73905c14b1 docs: redesign notes (#8661)
* docs: redesign notes

* fix color for warning notes

* allow optional links

* show links in a note

* allow line code in notes
2024-08-20 14:47:24 +02:00
Shahed Nasser
a77c23c915 docs: redesign code highlights + add default code titles (#8628)
* docs: code highlights improvements + default titles

* spacing fixes

* fix terminal detection

* add padding for non-terminal one liners
2024-08-19 13:34:07 +03: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
Shahed Nasser
c479fe8220 docs: added edit date (#8623) 2024-08-19 09:47:57 +03:00
Shahed Nasser
66c39ef876 docs: bug fixes for copy and color mode (#8626)
* docs: bug fixes for copy and color mode

* remove unused dependency
2024-08-18 17:01:15 +02:00
Shahed Nasser
559a6d70d9 docs: remove steps from workflows reference overview (#8595)
* docs: remove steps from workflows reference overview

* fix styling of typelist element

* fix categories with no items showing
2024-08-16 12:37:13 +03:00
Shahed Nasser
9bdcdc76a8 docs: redesign help button (#8610)
Redesign help button

Closes DOCS-817
2024-08-16 06:40:05 +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
5abe9f9c66 docs: fix expand badge (#8611)
* fix component

* update expand URL
2024-08-16 09:26: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
0b6bc7e05f docs: redesign pagination (#8614) 2024-08-16 09:25:53 +03:00
Shahed Nasser
4bd0917aed docs: change workflow diagram to list (#8602) 2024-08-15 16:47:27 +03:00
Shahed Nasser
3bdfb66238 docs: change from showing required to showing optional in types references (#8593) 2024-08-15 16:29:49 +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
cd0acbd921 docs: fixes and preparations for workflows reference (#8579)
- Fix the merger configuration that adds the correct slug / sidebar labels
- Add an overview page for the workflows reference.
- Fixes to components and build scripts
2024-08-13 12:30:55 +00: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
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
2682e2e324 docs: fix sidebar not updating when api reference path changes (#8409) 2024-08-05 13:20:53 +03:00
Shahed Nasser
6fabb7fad2 docs: fix local link to infer slug from front matter (#8353) 2024-07-30 18:59:16 +03:00
Shahed Nasser
0aac0f8bac docs: fix cross-project links to use base path in production (#8160) 2024-07-17 15:31:23 +03: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
Carlos R. L. Rodrigues
de36e2b36e chore: rename return flow (#8050) 2024-07-10 08:09:10 -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
3d6b1dc7ae docs: fix page crashing when using google translate (#8009) 2024-07-08 10:24:45 +02:00
Shahed Nasser
de0a9c14ab docs: fix pagination on mobile devices (#7968)
* docs: fix pagination on mobile devices

* fix algolia link
2024-07-05 12:40:42 +02:00