Shahed Nasser
96629f1916
docs: change process for generating docblocks through actions ( #6237 )
...
This PR changes the original process of generating docblocks through actions. The process now is:
1. When a PR is merged for the branch `changeset-release/develop`, the docblock generator tool us used to generate docblocks for the changed files. The changed files are determined by retrieving all comments since the last release and the files in each of those commits.
2. If there are changes after using the docblock generator tool, a PR is opened in the branch `chore/generate-tsdocs`.
3. Once the `chore/generate-tsdocs` is merged, it triggers an action that generates the references for the docs. This changes the previous behaviour of generating references on a new release.
Both actions (that runs the docblock generator tool and that generates references for the docs) can also be triggered manually.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2024-01-29 08:05:14 +00:00
Shahed Nasser
f29948a6a8
docs-util: created docblock-generator tool ( #6096 )
2024-01-24 11:13:40 +01:00
Shahed Nasser
3eee2bd5d6
chore(docs-util): update typedoc to v0.25.7 ( #6032 )
2024-01-09 11:27:17 +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
f802e2460f
docs: TSDoc + reference of fulfillment service ( #5761 )
2023-11-29 11:58:08 +00: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
4f91263588
chore: fix generate automated reference action ( #5589 )
...
* chore: fix generate automated reference action
* fix dependencies
* add depends in turbo
* add install step for www workspace
2023-11-09 17:14:28 +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
2ac05066ac
chore(docs-util): Improve generate references script and action ( #5472 )
...
* chore(docs-util): Improve generate references script and action
* added if condition for API reference
* fix api reference condition
* fix description of action
* fix body value
* fix step name
2023-10-25 17:12:10 +03:00
github-actions[bot]
9dcd62c731
chore(docs): Generated JS Client Reference ( #5421 )
...
* chore(docs): Generated JS Client Reference (automated)
* fix js client reference
* fix links
---------
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com >
Co-authored-by: Shahed nasser <shahednasser@gmail.com >
2023-10-20 14:01:27 +03:00
Shahed Nasser
f0af8ecc89
docs: generate pricing module reference ( #5349 )
...
* docs: generate pricing module reference
* added notes about new configurations
2023-10-11 14:08:19 +03:00
Shahed Nasser
9c1c19f409
chore(docs-util): fix dependencies installation ( #5345 )
2023-10-11 10:46:06 +03:00
github-actions[bot]
daea35fe73
chore(docs): Generated JS Client Reference ( #5334 )
...
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request ) GitHub action
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2023-10-10 17:47:07 +00:00
Shahed Nasser
ce93d75cc5
chore: fix generate reference command name in action ( #5320 )
...
* chore: fix generate reference command name
* fix require path in typedoc config
* add missing dependencies
2023-10-09 13:45:19 +03:00
Shahed Nasser
0350eeb0a1
docs: create typedoc theme and plugins for references ( #5297 )
...
* update typedoc and its plugins
* refactor existing typedoc configurations
* added new typedoc plugin and themes
* added more customization options
* added more customization options
* refactored doc-utils to a workspace
* fix tsconfig
* update README files
* remove comments
* revert type changes
* remove dependencies no longer needed
* removed modules action
2023-10-05 12:09:42 +03:00
