Commit Graph

25 Commits

Author SHA1 Message Date
Shahed Nasser
54d9edc1ab docs: improve instructions to install Medusa UI in standalone projects (#13104) 2025-07-31 16:04:20 +03:00
Shahed Nasser
a6c1329da2 docs: added examples to DatePicker component (#13054) 2025-07-25 18:58:19 +03:00
Shahed Nasser
c35e9e5104 docs: fix local links in UI docs (#12359) 2025-05-05 11:50:01 +03:00
Shahed Nasser
dcb4788af9 docs: fix no lines code block example (#12259) 2025-04-22 19:03:44 +03:00
Shahed Nasser
92514885e4 docs: add section on row click in DataTable (#11694)
* docs: add section on row click in DataTable

* update subscriptions example
2025-03-03 18:08:06 +02:00
github-actions[bot]
7799647675 chore(docs): Updated UI Reference (automated) (#11578)
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>
2025-02-24 11:23:30 +00:00
Shahed Nasser
c8fc5edadd docs: add documentation for DataTable (#11095)
* docs: add documentation for DataTable

* update package versions
2025-01-27 11:04:46 +02:00
Shahed Nasser
9462f00f8d docs: add updates documentation (#11146)
- Add chapter on updating Medusa
- Add section in UI docs about updating UI packages in standalone applications

Closes #10927
Closes DX-1282
2025-01-27 07:27:37 +00:00
Shahed Nasser
1c355dac36 docs: update and fix UI props docs (#10754) 2024-12-27 14:53:46 +02:00
Shahed Nasser
fd26839616 docs: fixes to ui docs (#9759) 2024-10-25 11:56:54 +03:00
github-actions[bot]
e196ad7659 chore(docs): Updated UI Reference (automated) (#9726)
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-24 09:38:58 +00:00
Shahed Nasser
b4d8e265e3 docs: redesign cards (#8671)
* docs: redesign cards

* fix build error
2024-08-20 14:48:17 +02:00
Muhammad Naimul Islam
2b55208c1c docs: fix component title and description in alert.mdx (#7435)
- Removed the incorrect title and description from the Alert component page
- Added new title and description for the Alert component page
2024-05-24 15:55:42 +00:00
Shahed Nasser
b6083ce104 docs: added documentation for toast component changes (#7141)
* docs: added documentation for toast component changes

* added redirect from use-toast docs to upgrade guide

* remove unused file

* content linting fixes

* update UI package version

* updated ui preset

* fix upgrade guides main page
2024-05-01 18:12:10 +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
github-actions[bot]
869dc751a0 chore(docs): Updated UI Reference (#6347)
* chore(docs): Generated UI Reference

* fixed props typing + added new alert page

* updated ui dependencies

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2024-02-12 19:46:51 +01:00
github-actions[bot]
dfd9e7c772 chore(docs): Updated UI Reference (#6221)
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-01-29 08:20:51 +00:00
Shahed Nasser
97fd67bdd3 docs: improvements of docs UI (#6038)
* docs: improvements of docs UI

* changed note about icon sizes
2024-01-09 19:21:12 +02:00
Shahed Nasser
245e5c9a69 docs: generate documentation for UI components (#5849)
* added tool to generate spec files for React components

* use typedoc for missing descriptions and types

* improvements and fixes

* improvements

* added doc comments for half of the components

* add custom resolver + more doc comments

* added all tsdocs

* general improvements

* add specs to UI docs

* added github action

* remove unnecessary api route

* Added readme for react-docs-generator

* remove comment

* Update packages/design-system/ui/src/components/currency-input/currency-input.tsx

Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>

* remove description of aria fields + add generate script

---------

Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>
2023-12-13 16:02:41 +02:00
Kasper Fabricius Kristensen
a2a45b6fef fix: minor fixes to IconButton and Button documentation (#5636)
**What**
- Updates example on IconButton page so it no longer uses IconBadge
- Removes the "small" size from Button props as it no longer exists.
2023-11-15 15:53:05 +00:00
Shahed Nasser
c28935b4e8 docs: update endpoints to use file-routing approach (#5397)
- Move the original guides for creating endpoints and middlewares to sub-sections in the Endpoints category.
- Replace existing guides for endpoints and middlewares with the new approach.
- Update all endpoints-related snippets across docs to use this new approach.
2023-10-19 15:56:26 +00:00
Tek Loon
dc298acefc docs(admin-ui): Fix incorrect Radix UI Select Reference Link (#5248)
* fix: add ProductCollectionDetailsWidgetProps

* fix(doc): fix incorrect Radix UI Select reference link

---------

Co-authored-by: Tek Loon <tekloon.1991@gmail.com>
2023-09-29 12:47:11 +03:00
Kasper Fabricius Kristensen
4e3f3b54cb docs(ui,docs): Add documentation for Medusa UI 2.0.0 (#5227)
* add docs for medusa ui 2.0.0

* fix: copy as child example

* fix: dropdown menu example

* add accordion examples

* fix lint issues

* fix apos in progress tabs demo

* resolve comments

* add icon

* bump z-index on modals to prevent clashing with navbar

* add sidebar item and card

* undo modal z index changes

* add links to updated and new components

* update version

* rm inline code formatting on links

---------

Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2023-09-27 18:56:25 +03:00
Shahed Nasser
987dd8f568 docs: expanded rating form + UI docs improvement (#5211)
* docs: expanded rating form + UI docs improvement

* added props table + changed example
2023-09-26 20:26:09 +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