Commit Graph

28 Commits

Author SHA1 Message Date
Shahed Nasser
7d498227d1 docs: fix core flows reference not generating (#12274) 2025-04-23 19:46:54 +03:00
Shahed Nasser
fde85888bd docs-util: handle workflows with intersection hook types (#12099) 2025-04-07 14:00:08 +03:00
Shahed Nasser
49bf934da3 docs-util: fix inline code escape in generated references (#11428) 2025-02-12 19:08:37 +02:00
Shahed Nasser
0d18d5854a docs: fixes for core workflows reference (#11056)
* docs: fix step input / output description not showing

* fix generated example for array types

* show workflow summary in diagram

* fix workflow node width

* hide undefined types
2025-01-20 17:34:02 +02:00
Shahed Nasser
044af3f211 docs-util: add exception for workflow examples modification + show summary instead of comment (#10963)
* docs-util: add exception for workflow examples modification + show summary instead of comment

* add currency and country code in example

* add common IDs
2025-01-14 18:47:56 +02:00
Shahed Nasser
1b86c17b72 docs-util: remove duplicate union children (#10942) 2025-01-13 19:48:51 +02:00
Shahed Nasser
c5915451b8 docs-util: add examples generator for workflows and steps (#10914)
* initial changes

* docs-util: generate examples for workflows and steps
2025-01-10 19:16:43 +02:00
Shahed Nasser
a607b8e800 docs-util: fix hook input type showing as __type (#10905) 2025-01-10 10:25:17 +02:00
Shahed Nasser
870cb6e88c docs: update typedoc, convert packages to esm, generate references (#10699) 2024-12-23 15:20:09 +02:00
Shahed Nasser
ee62083c52 docs-util: infer resolved resources in workflow + steps (#10637) 2024-12-17 19:03:00 +02:00
Shahed Nasser
2a73d0ac0d docs-util: support @tags comments (#10627)
* support tags in tsdocs + add them in frontmatter

* fixes
2024-12-17 13:07:59 +02:00
Shahed Nasser
376b9e85bc docs: regenerate references for core flows (#10538) 2024-12-10 19:28:35 +02:00
Shahed Nasser
482929f74d docs: fix page title in reference pagesnot showing + refactor workflows reference (#10537)
* docs: fix references title + refactor workflow reference generation

* update references sidebar
2024-12-10 18:19:03 +02:00
Shahed Nasser
5fec006371 docs-util: fix helper step settings (#10045) 2024-11-13 11:01:14 +02:00
Shahed Nasser
b07dd33a57 docs-util: add configuration to generate js-sdk reference (#9630) 2024-10-17 19:32:21 +03:00
Shahed Nasser
bd4d2fd554 docs-util: fixes following packages reorg (#9326)
- Typescript config aren't picked up properly anymore since they're moved to `_tsconfig.base.json` in the root. So, we now read the config from the config file.
- Update Typescript version in the `utils` monorepo to match that of the root monorepo
2024-09-26 17:22:08 +00:00
Shahed Nasser
4ffcc41fe7 chore(utils): update auth provider TSDocs + fix errors stopping references build (#9023)
- Updated the TSDocs of the auth provider
- Update the Node version in the docs-util as the outdated version was causing TypeScript error
- Add `@ts-ignore` for a line that was causing a typescript error. If there's a better fix here let me know
2024-09-09 13:53:33 +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
fe200e0bb3 docs-util: added a namespaces plugin (#8500)
Added a namespaces plugin that allows generating namespaces and automatically adds reflections in a path pattern to the namespace.

This is particularly useful for the workflows reference, as workflows under the `**/packages/core/core-flows/**/workflows/**` path pattern are shown under a Workflows title, and steps under the path pattern `**/packages/core/core-flows/**/steps/**` are shown under a Steps title.
2024-08-08 13:03:42 +00:00
Shahed Nasser
c870302400 docs-util: added workflows typedoc plugin (#8463)
* initial changes

* finish workflow plugin

* add comments

* remove todo
2024-08-06 14:23:24 +03:00
Shahed Nasser
d4c9c1e7cd docs-util: fix how data model name is inferred (#8351) 2024-07-30 18:59:29 +03:00
Shahed Nasser
d127abbcda docs-util: add docblock generator for models built with DML (#8296)
* docs-util: add docblock generator for models built with DML

* add missing turbo task
2024-07-29 10:11:39 +02:00
Carlos R. L. Rodrigues
de36e2b36e chore: rename return flow (#8050) 2024-07-10 08:09:10 -03:00
Shahed Nasser
dd864da4e0 generate references (#7882) 2024-07-01 16:02:36 +03:00
Shahed Nasser
1f360a3245 docs-util: support models implemented with DML in typedoc custom plugins (#7847)
- Support generating reference for models implemented with DML
- Support resolving and generating mermaid diagram for relations

The Currency Module was used an example so its reference is generated to showcase the work of this PR.
2024-07-01 07:34:51 +00:00
Shahed Nasser
72f7500c84 chore(docs): DML API Reference (#7863)
* added dml options

* added tsdocs + configurations
2024-07-01 10:21:56 +03:00
Shahed Nasser
6e65158af3 docs-util: Upgrade typedoc to 0.26 (#7853)
Upgrade typedoc to v0.26 + make changes based on the update

Note: This update produces an error when generating model references when the models use the `createPsqlIndexStatementHelper` decorator. As this isn't a breaking error, and as we'll move to DML in the future, it's not necessary to spend time on a fix.
2024-06-27 10:52:44 +00:00
Shahed Nasser
b39de05535 chore: move docs-util to www (#7232)
* reorganize docs apps

* add README

* fix directory

* add condition for old docs

* move docs-util to www

* remove remaining docs-util

* fixes of paths

* fix scripts

* path fixes

* fix github actions

* add build packages script
2024-05-06 09:13:50 +03:00