Shahed Nasser
f81eb51b67
docs: add copy subscriber button ( #12405 )
...
* docs: add copy subscriber button
* re-generate
* fixes + update copy button
2025-05-08 12:48:44 +03: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
af350c3a8b
docs: add search to workflows reference ( #11054 )
...
* docs: add search to workflows reference
* fix error
2025-01-20 17:02:29 +02:00
Shahed Nasser
cf62a0a43c
docs: handle step tooltip bug in safari ( #10954 )
2025-01-14 12:08:59 +02:00
Shahed Nasser
a1738f823c
docs: change report issue link ( #10160 )
2024-11-19 15:54:16 +02: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
a19c562bec
docs-util: add support for workflows in markdown theme ( #8485 )
...
* add template for workflows
* initial changes
* added support for parallel steps
* added support for when
* added merge options
* fix merge options
* fix to tooltip
* clean up
* remove redirects
* fixes
* theme fixes + added merge options
* generate hook examples + fixes
* changed namespaces
* add custom autogenerator
* change type of additional data
2024-08-09 16:35:52 +03:00
Shahed Nasser
4c89f91caf
docs: fix download button + other fixes ( #8032 )
...
- Fix text of download button
- Small fix to styling on small devies
- Fix mobile sidebar items using incorrect base url
2024-07-09 12:36:02 +00:00
Shahed Nasser
70c4ffff8b
docs: improve API testing feature ( #7311 )
2024-05-14 10:12:53 +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
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
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
