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
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
ddc6cc13a0
docs: add TSDoc for payment processor + generate docs ( #5917 )
...
* added tsdocs for payment processor
* generated reference for payment processor
2023-12-18 14:02:18 +02:00
Shahed Nasser
fde1e23995
chore: refactored docs-util ( #5876 )
2023-12-14 18:25:40 +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
892d737c1f
docs: enhance how references are generated ( #5805 )
...
* adjusted configurations
* enhancements to tool and configurations
* change reference in docs
* fixed issue in workflows reference
* added project name
* more optimizations
* fix context error
* added a types reference
* resolved missing types
* fix reference reflection types not having children
* add an expand url parameter
* added new option to the README
* added details about new option
2023-12-05 15:29:41 +02:00
Shahed Nasser
f3e20379b0
chore: added TSDoc for workflow utility functions ( #5674 )
...
* feat(translation): Init plugin
* Create migration and entity
* Start service implementation
* fix typo
* typings
* config
* lang -> locale
* chnge config
* link
* update link
* update export
* workflow composer (wip)
* workflow step/workflow
* simplify api
* Add structured tests
* Add step name onto the step function for future usage
* new abstraction level of exported workflow
* cleanup
* rm step 4
* Add parallelize support to workflow composition
* add Symbols and support primitive types as input
* rem .only
* eslint
* cleanup + test
* resultFrom
* prevent undefined from crashing
* finalise tests
* chore: transform
* chore: tests and transform type
* move translation to my dummy
* chore: copy before transform
* yarn.lock
* chore: shortcut to property access
* Add type safety
* WIP typesafety
* WIP
* finalise typings
* remove extends unknown
* WIP
* finalise transform typings
* finalise transform typings
* workflow typs
* More typings in invoke and compensate
* rm comment
* Context as the last args
* fix step function type
* types
* fixes
* fixes compose
* chore: transform
* chore: fix tests and transform Proxy
* chore: args length
* uncomment
* chore: array fill
* WIP fix filler
* WIP fix filler
* chore: remove only
* apply gap filler to create step invoke
* context first
* fixes
* wofkrlow ts documentation
* wofkrlow ts documentation
* wofkrlow ts documentation
* wofkrlow ts documentation
* wofkrlow ts documentation
* chore: hook
* hook types
* update types
* don't loose previous iteration
* update implementation
* fix some tests part 1
* finalise typings
* rm new lines
* fixes
* wip
* fixes
* fix tests
* simplify types
* simplify types
* update export
* improve types exclusion compensateInput
* allow a workflow to return plain object composed of stepReturn properties
* only allow one handler for the hook registration
* only allow one handler for the hook registration
* workflow loading
* lint
* lint
* lint
* finalise tests
* try to fix ci
* try to fix ci
* remove corepack step
* cleanup
* cleanup
* cleanup
* chore: context as 2nd argumentq
* added tsdoc for some workflow functions
* Add support for StepResponse and re work the typings
* changeset
* chore: invoke output as default compensate input
* copy data
* copy data
* fix createWorkflow result
* added tsdoc to remaining utility functions
* rm test file
* proxify input and transformer as well
* transformer should re run + type update
* rework step response
* allow void return from steps
* updates to the TSDocs
* address comments
* address PR feedback
* add await for API Route examples
* ignore documenting hooks
---------
Co-authored-by: adrien2p <adrien.deperetti@gmail.com >
Co-authored-by: Carlos R. L. Rodrigues <rodrigolr@gmail.com >
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com >
2023-11-23 16:38:43 +00: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
