Shahed Nasser
964927b597
docs: general fixes and improvements ( #7918 )
...
* docs improvements and changes
* updated module definition
* modules + dml changes
* fix build
* fix vale error
* fix lint errors
* fixes to stripe docs
* fix condition
* fix condition
* fix module defintion
* fix checkout
* disable UI action
* change oas preview action
* flatten provider module options
* fix lint errors
* add module link docs
* pr comments fixes
* fix vale error
* change node engine version
* links -> linkable
* add note about database name
* small fixes
* link fixes
* fix response code in api reference
* added migrations step
2024-07-04 17:26:03 +03:00
Shahed Nasser
98615c388b
docs-util: fixes to base OAS + circular-patch redocly plugin ( #7382 )
...
* docs-util: remove MultipleErrors schema from base OAS
* fixes to circular patch plugin
* general fixes
* change nested schemas to references
2024-05-27 14:29:48 +02:00
Shahed Nasser
7cb90f8e82
docs: editing and general fixes of medusa's learning resources ( #7261 )
...
* docs: editing and general fixes of medusa's learning resources
* fix build script
* update ui dependency
* fix build
* adjust next.js steps
2024-05-13 18:55:11 +03:00
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
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
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
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
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
