Commit Graph

28 Commits

Author SHA1 Message Date
github-actions[bot]
d24c819e7d chore(docs): Updated UI Reference (#6754)
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-03-22 15:26:11 +00: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
3b18f399c1 docs(ui): show icon tooltip on small devices (#6407) 2024-02-26 08:31:36 +01: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
0b0c25da11 docs: update dependencies (#6046) 2024-01-10 10:56:54 +02: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
18de90e603 docs: fix tsdocs following typedoc update + 1.20 release (#6033)
* docs: fix tsdocs following typedoc update + 1.20 release

* Fix OAS validation errors

* fixes to react-docs-generator

* fix content linting
2024-01-09 17:15:29 +02:00
Shahed Nasser
761d2e7a69 docs: update documentation websites (#5882)
* docs: update next.js to 14.0.4

* update docusaurus to v3.0.1

* update packages dependencies

* added engines

* update lock
2023-12-14 20:43:16 +02:00
Shahed Nasser
c0ce969cd7 docs: fixed sidebar in API reference (#5871) 2023-12-14 13:26:24 +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
a67a8e7e90 fix(ui): Fixed CodeBlock line number width (#5640)
**What**
- Fixes the width of lineNumbers in the CodeBlock component according to the widest number.
- Introduces a new prop on snippets that allows users to hide the copy button. Also updated docs to reflect this.

Before:
![image](https://github.com/medusajs/medusa/assets/45367945/07852c2e-434c-44df-93b7-4078148cb74f)

After:
<img width="742" alt="image" src="https://github.com/medusajs/medusa/assets/45367945/5ce845f7-b8c7-411c-abfb-fa03448aeb1a">

Closes #5639
2023-11-16 10:50:04 +00: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
Shahed Nasser
4ca70a0d0c docs: fix horizontal scroll (#5300) 2023-10-05 22:38:54 +03:00
Shahed Nasser
b3f75d8f21 docs: add AI Assistant (#5249)
* added components

* added ai assistant button

* change styling

* improve AI assistant

* change to a drawer

* added command support into search

* add AiAssistant to all projects

* remove usage of Text component

* added error handling

* use recaptcha

* fix new configurations

* fix background color

* change suggested questions
2023-10-05 11:10:44 +03:00
Shahed Nasser
7016c8940c docs: fix design issues (#5252)
* docs: fix design issues

* fix commands in installation tabs
2023-09-29 17:17:24 +03: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
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
11b2f1237b docs: fix irregular scrolling in code tabs (#5239)
* docs: fix blocking scroll util

* remove unnecessary util methods
2023-09-27 19:17:04 +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
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
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
63aea62d7a docs: improve tailwind configuration (#5215) 2023-09-26 15:08:30 +03:00
Shahed Nasser
797cd48bd3 docs(ui): dark mode fixes (#5204)
* docs(ui): dark mode fixes

* apply color on the body

* remove z-index
2023-09-25 18:36:42 +03:00
Shahed Nasser
123b3787d5 docs: general fixes for docs workspace (#5184) 2023-09-22 12:25:48 +03:00
Shahed Nasser
27d74cb399 docs: fix error related to Key type (#5178)
* docs: fix error related to Key type

* fix styling issue
2023-09-21 21:41:18 +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