Commit Graph

11 Commits

Author SHA1 Message Date
Shahed Nasser
dd864da4e0 generate references (#7882) 2024-07-01 16:02:36 +03:00
Shahed Nasser
b9036eca1a docs: generate OAS for v2 (#7883) 2024-07-01 15:35:45 +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
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
2c5ba408d4 docs: edits and fixes to commerce module docs (#7468)
Apply edits and fixes to the commerce modules docs
2024-05-29 11:08:06 +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
154673f3d8 docs: fixes and changes based on latest updates (#7322)
* docs: changes based on DX changes

* remove fields no longer needed

* remove unnecessary parameters

* fixes to authenticate middleware usage

* add highlight to migrations config

* change configuration to http

* added missing remote link docs

* fix name in sidebar

* added notification module docs + updated file module docs

* add vale exceptions

* fix vale errors

* added docs on custom cli scripts
2024-05-22 13:37:48 +03:00
Shahed Nasser
803e4aad02 docs: added file module docs (#7278) 2024-05-13 18:54:59 +03:00
Shahed Nasser
8b2429d24f chore(medusa-oas-cli,oas-github-ci): remove v2 option + generate v2 by default (#7304)
* chore(medusa-oas-cli,oas-github-ci): remove v2 option + generate v2 by default

* fixes to changeset

* fix public url path
2024-05-13 17:01:38 +03:00
Shahed Nasser
7b2879d643 chore(docs): Fix docblock-generator OAS tool's max-stack error (#7246)
* regenerate oas to fix duplicate keys

* fix clean:oas script

* fix max-stack errors

* fix max-level condition
2024-05-06 13:41:59 +03: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