Feature/idp 1987 update docs (#27)

* improve documentation

* fix type

* fix diagram namings

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "bierner.markdown-mermaid",
+    ],    
+}

README.md

@@ -12,6 +12,7 @@ Tools to generate TypeScript schemas from OpenAPI. It leverage [openapi-typescri
 | [@workleap/create-schemas](https://www.npmjs.org/package/@workleap/create-schemas)| [![NPM Version](http://img.shields.io/npm/v/@workleap/create-schemas.svg?style=flat)](https://www.npmjs.org/package/@workleap/create-schemas) |
 
 
+
 ## Usages
 
 Add a script in package.json to call `@workleap/create-schemas`
@@ -188,6 +189,13 @@ export type Endpoints = keyof paths;
 
 For more details on how to use see [openapi-typescript documentation](https://openapi-ts.pages.dev/introduction)
 
+## Documentation
+
+For documentations, please visit [our website](https://gsoft-inc.github.io/wl-openapi-typescript/).
+
+The documentation is automatically generated on each release from the files in the docs directory.
+
+
 ## 🤝 Contributing
 
 View the [contributor's documentation](./CONTRIBUTING.md).

docs/retype.yaml

@@ -20,6 +20,12 @@ edit:
     base: ./apps/docs/src
     branch: main
 
+links:
+  - text: Github
+    icon: mark-github
+    link:https://gsoft-inc.github.io/wl-openapi-typescript
+    target: blank
+
 footer:
     copyright: "© Copyright {{ year }} - Workleap"
 

docs/src/using-plugins.md

@@ -142,6 +142,10 @@ The Plugin API is currently marked as **unstable**. It may change at any time.
 If you desire a specific plugin, please [open an issue on Github](https://github.com/gsoft-inc/wl-openapi-typescript/issues).
 !!!
 
+!!!
+This work is inspired by [Rollup plugin development](https://rollupjs.org/plugin-development/).
+!!!
+
 A plugin is an object with a `name` and one or more [build hooks](#build-hooks), which follows our conventions. A plugin should export a function that can be called with plugin specific options and returns such an object.
 
 Plugins allow you to customize `@workleap/create-schemas` behavior by, for example, modifying code before writing the files to disk.
@@ -186,8 +190,10 @@ flowchart TB
     classDef parallel fill:#FFB3B3,color:black
     classDef sequential fill:#FFD2B3,color:black
 
-    parallel(parallel):::parallel 
-    sequential(sequential):::sequential 
+    subgraph Legend
+        parallel(parallel):::parallel 
+        sequential(sequential):::sequential 
+    end 
 
     subgraph generate
         direction TB
@@ -196,7 +202,9 @@ flowchart TB
         --> gen_C(buildEnd):::parallel
     end
 
-    A[start] --> B(resolveConfig) --> generate  --> E[write files]
+    subgraph  
+        A[start] --> B(resolveConfig) --> generate  --> E[write files]
+    end
 ```
 
 ### buildStart