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
92dd855290
docs: restructure api-reference to allow base path ( #7954 )
2024-07-04 16:12:02 +00:00
Shahed Nasser
1acbcf612e
docs: fix api-reference with proxy ( #7952 )
2024-07-04 17:10:48 +02:00
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
6713d76db3
docs: prepare configuration ( #7877 )
...
* update configuration
* resolve todos + remove events guides
* disable v2 docs in v1 navbar
* remove v2 from v1 mobile sidebar
* resolve build errors
* fix build errors
* fix lint errors
* fix lint
2024-07-03 19:27:13 +03:00
Shahed Nasser
c38f6d07c2
docs: update design + colors ( #7593 )
...
Update design and colors in docs to match those in Figma
2024-06-04 07:41:24 +00: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
22f30f54fd
docs: update api-reference project for v2 ( #7307 )
...
* remove everything v1 and make v2 default
* move main v2 rewrites to book
* move rewrites to book + other fixes
2024-05-16 09:02:35 +02:00
Shahed Nasser
728c5ee53c
docs: preparations for preview ( #7267 )
...
* configured base paths + added development banner
* fix typelist site url
* added navbar and sidebar badges
* configure algolia filters
* remove AI assistant
* remove unused imports
* change navbar text and badge
* lint fixes
* fix build error
* add to api reference rewrites
* fix build error
* fix build errors in user-guide
* fix feedback component
* add parent title to pagination
* added breadcrumbs component
* remove user-guide links
* resolve todos
* fix details about authentication
* change documentation title
* lint content
2024-05-13 11:32:52 +03:00
Shahed Nasser
1a68f4602c
feat(api-ref): show schema of a tag ( #7297 )
2024-05-10 21:07:35 +03:00
Shahed Nasser
5d0ffe8ff4
docs: refactored versioning in api reference + modified v2 content ( #7274 )
2024-05-09 17:23:49 +03:00
Shahed Nasser
0c12d7e7d7
docs: add note about expanding nested relations ( #7008 )
2024-04-15 09:32:57 +02: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
91615f9c45
chore: improve JS Client TSDoc comments ( #5582 )
...
* add oas schema to tsdoc parser
* add tsdoc (part 1)
* Finished tsdoc in js client
* general fixes
* added tsdoc in core medusa package
* parse schema tags in model files
* added maxlevel option
* added more tsdoc
* added tsdoc in core
* added TSDoc in core package
* generated client types
* support featureFlag and expandable tags
* added support for resource feature flag note
* fix api ignore plugin
* added eslint plugin
* support feature flag and expandable badges
* adjusted overview page + generated reference
* revert generated files
* added changeset
* add details about new typedoc options
* fix broken link
2023-11-09 12:51:17 +02:00
Shahed Nasser
c1b97050ab
feat(medusa-oas-cli,oas-github-ci): new options + added download of OAS in api reference ( #5453 )
2023-10-31 08:05:48 +01: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
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
63aea62d7a
docs: improve tailwind configuration ( #5215 )
2023-09-26 15:08:30 +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
