Commit Graph

32 Commits

Author SHA1 Message Date
Shahed Nasser
74e93b3079 docs: fixes to navbar and sidebar in mobile (#12379)
* docs: fixes to navbar and sidebar in mobile

* fix height issues
2025-05-06 19:11:15 +03:00
Shahed Nasser
9ead47c51e docs: add prepare script to generate sidebar (#11894) 2025-03-18 17:37:51 +02:00
Shahed Nasser
87b041800a fixes + added new sidebars 2025-03-10 08:33:21 +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
ecc3deb362 docs: changes to main docs sidebar (#11750)
* docs: changes to main docs sidebar

* fix links

* fix vale test

* fix vale errors
2025-03-06 11:55:56 +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
c99b03bcc2 docs: change logo (#10208)
* docs: changed logo

* remove unused component
2024-11-21 18:15:32 +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
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
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
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
22d92aa70a docs: add tracking for navigation usage (#8819) 2024-08-28 15:44:54 +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
b6f990c017 docs: design polish (#8696)
* polish

* finish polish

* change typography
2024-08-21 20:04:43 +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
43202dde0f docs: redesign footer (#8651) 2024-08-20 14:47:53 +02: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
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
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
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
22f30f54fd docs: update api-reference project for v2 (#7307)
* remove everything v1 and make v2 default

* move main v2 rewrites to book

* move rewrites to book + other fixes
2024-05-16 09:02:35 +02:00
Shahed Nasser
728c5ee53c docs: preparations for preview (#7267)
* configured base paths + added development banner

* fix typelist site url

* added navbar and sidebar badges

* configure algolia filters

* remove AI assistant

* remove unused imports

* change navbar text and badge

* lint fixes

* fix build error

* add to api reference rewrites

* fix build error

* fix build errors in user-guide

* fix feedback component

* add parent title to pagination

* added breadcrumbs component

* remove user-guide links

* resolve todos

* fix details about authentication

* change documentation title

* lint content
2024-05-13 11:32:52 +03:00
Shahed Nasser
bb87db8342 docs: prep for v2 documentation (#6710)
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs).

_Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._

## Changes

- Change Medusa version in base OAS used for v2.
- Fix to docblock generator related to not catching all path parameters.
- Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules.
- Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used.
- Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment.
- Upgraded docusaurus to v3.0.1
- Added new Vale rules to ensure correct spelling of Medusa Admin and module names.
- Added new components to the `docs-ui` package that will be used in future documentation changes.
2024-03-18 07:47:35 +00:00
Shahed Nasser
c0ce969cd7 docs: fixed sidebar in API reference (#5871) 2023-12-14 13:26:24 +02:00
Shahed Nasser
aecf719871 docs(ui,docs): added upgrade guides link to UI docs (#5240)
* added medusa ui index page

* remove console
2023-09-27 20:06:03 +03:00
Shahed Nasser
6942a907a5 docs: fix z-index across projects (#5234)
* docs: fix z-index across projects

* remove usage of z-index in UI docs
2023-09-27 16:38:59 +03:00
Shahed Nasser
63aea62d7a docs: improve tailwind configuration (#5215) 2023-09-26 15:08:30 +03:00
Shahed Nasser
fa7c94b4cc docs: create docs workspace (#5174)
* docs: migrate ui docs to docs universe

* created yarn workspace

* added eslint and tsconfig configurations

* fix eslint configurations

* fixed eslint configurations

* shared tailwind configurations

* added shared ui package

* added more shared components

* migrating more components

* made details components shared

* move InlineCode component

* moved InputText

* moved Loading component

* Moved Modal component

* moved Select components

* Moved Tooltip component

* moved Search components

* moved ColorMode provider

* Moved Notification components and providers

* used icons package

* use UI colors in api-reference

* moved Navbar component

* used Navbar and Search in UI docs

* added Feedback to UI docs

* general enhancements

* fix color mode

* added copy colors file from ui-preset

* added features and enhancements to UI docs

* move Sidebar component and provider

* general fixes and preparations for deployment

* update docusaurus version

* adjusted versions

* fix output directory

* remove rootDirectory property

* fix yarn.lock

* moved code component

* added vale for all docs MD and MDX

* fix tests

* fix vale error

* fix deployment errors

* change ignore commands

* add output directory

* fix docs test

* general fixes

* content fixes

* fix announcement script

* added changeset

* fix vale checks

* added nofilter option

* fix vale error
2023-09-21 20:57:15 +03:00