Shahed Nasser
4fe28f5a95
chore: reorganize docs apps ( #7228 )
...
* reorganize docs apps
* add README
* fix directory
* add condition for old docs
2024-05-03 17:36:38 +03: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
0b0c25da11
docs: update dependencies ( #6046 )
2024-01-10 10:56:54 +02:00
Shahed Nasser
7d650771d1
docs: generate medusa-react reference ( #6004 )
...
* add new plugin for better organization
* added handling in theme for mutations and query types
* added tsdoc to hooks
* added tsdocs to utility functions
* added tsdoc to providers
* generated reference
* general fixes for generated reference
* generated api reference specs + general fixes
* add missing import react
* split utilities into different directories
* added overview page
* added link to customer authentication section
* fix lint errors
* added changeset
* fix readme
* fixed build error
* added expand fields + other sections to overview
* updated what's new section
* general refactoring
* remove unnecessary query field
* fix links
* added ignoreApi option
2024-01-05 17:03:38 +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
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
Shahed Nasser
fa4935259c
docs: diagrams plugin tooling ( #5741 )
...
* added plugin
* updated plugin + added component
* dummy data TO BE REMOVED
* (wip) workflow generator tool
* add workflow generator tooling
* updated the generator tool
* added code file creation
* fix design of diagrams
* configured diagram theme
* added build script
* removed comments + unnecessary files
* general fixes
* refactored plugin
* added README + more output types
2023-11-28 14:30:23 +00:00
Shahed Nasser
547b16ead5
docs: fix code block titles ( #5733 )
...
* docs: fix code block titles
* remove console
* fix build error
2023-11-27 16:08:10 +00:00
Shahed Nasser
c6dff873de
docs: update docusaurus to v3 ( #5625 )
...
* update dependencies
* update onboarding mdx
* fixes for mdx issues
* fixes for mdx compatibility
* resolve mdx errors
* fixes in reference
* fix check errors
* revert change in vale action
* fix node version in action
* fix summary in markdown
2023-11-13 20:11:50 +02: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
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
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
Patrick
621a37cb68
chore(docs): remove unused files from www directory
2022-12-05 10:23:09 -05:00
Shahed Nasser
36e2e7a4df
chore: fix for deployment ( #1970 )
...
* fix for deployment
* fixed gitignore files to match that of the root
* add to gitignore in root
2022-08-02 17:16:18 +03:00
dependabot[bot]
d113e3f7bf
chore(deps): bump parse-url from 6.0.0 to 6.0.2 in /www ( #1805 )
...
Bumps [parse-url](https://github.com/IonicaBizau/parse-url ) from 6.0.0 to 6.0.2.
- [Release notes](https://github.com/IonicaBizau/parse-url/releases )
- [Commits](https://github.com/IonicaBizau/parse-url/commits )
---
updated-dependencies:
- dependency-name: parse-url
dependency-type: indirect
2022-07-06 14:03:15 +02:00
Oliver Windall Juhl
f76aa816a5
feat: Documentation and API reference ( #348 )
...
Co-authored-by: Vadim Smirnov <smirnou.vadzim@gmail.com >
Co-authored-by: zakariasaad <zakaria.elas@gmail.com >
Co-authored-by: Vilfred Sikker <vilfredsikker@gmail.com >
Co-authored-by: Kasper <kasper@medusa-commerce.com >
Co-authored-by: Sebastian Rindom <skrindom@gmail.com >
Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com >
2021-08-24 18:16:42 +02:00
Kasper Fabricius Kristensen
143f06aa39
feat: Update to API references look and feel ( #343 )
...
Co-authored-by: Vadim Smirnov <smirnou.vadzim@gmail.com >
Co-authored-by: zakariasaad <zakaria.elas@gmail.com >
Co-authored-by: Vilfred Sikker <vilfredsikker@gmail.com >
Co-authored-by: olivermrbl <oliver@mrbltech.com >
2021-08-20 10:26:29 +02:00
Sebastian Rindom
1e5a1398d8
hotfix: docs build ( #198 )
...
* fix: build
* fix: build
* fix: build
* fix: build
2021-03-10 16:15:06 +01:00
Sebastian Rindom
8edb32c742
docs: oas ( #197 )
...
Adds OpenAPI specification of Storefront and Admin APIs.
Updates docs project.
2021-03-10 11:51:54 +01:00
olivermrbl
34e6c52745
chore: updates API reference docs
2020-12-15 13:49:45 +01:00
Sebastian Rindom
47e2ad2952
docs: adds first version of REST docs ( #116 )
2020-09-30 21:17:22 +02:00