feat(docs): update docs (#1004)

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
winglang · Sep 4, 2024 · 8015356 · 8015356
1 parent 3363d9d
commit 8015356
Show file tree

Hide file tree

Showing 28 changed files with 1,332 additions and 890 deletions.
diff --git a/versioned_docs/version-latest/04-winglibs/04-toc.md b/versioned_docs/version-latest/04-winglibs/04-toc.md
@@ -8,36 +8,36 @@ keywords: [winglib, Wing library]
 
 | Library  | Package name  | Version | Description  | Supported Wing platforms |
 | -------- | ------- | ------- | ------- | ------- |
-| [Amazon Bedrock](/docs/winglibs/winglibs/bedrock) | [@winglibs/bedrock](/docs/winglibs/winglibs/bedrock) |  v0.1.1 | A Wing library for Amazon Bedrock  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [AWS Budget](/docs/winglibs/winglibs/budget) | [@winglibs/budget](/docs/winglibs/winglibs/budget) |  v0.1.6 | A Wing library for working with [AWS Budgets]  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [Cloud checks](/docs/winglibs/winglibs/checks) | [@winglibs/checks](/docs/winglibs/winglibs/checks) |  v0.0.17 | A self-validation mechanism for cloud applications  | [*](/docs/platforms/platforms) |
-| [cloudv2](/docs/winglibs/winglibs/cloudv2) | [@winglibs/cloudv2](/docs/winglibs/winglibs/cloudv2) |  v0.1.1 | Standard cloud library for Wing  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [Amazon Bedrock](/docs/winglibs/winglibs/bedrock) | [@winglibs/bedrock](/docs/winglibs/winglibs/bedrock) |  v0.1.2 | A Wing library for Amazon Bedrock  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [AWS Budget](/docs/winglibs/winglibs/budget) | [@winglibs/budget](/docs/winglibs/winglibs/budget) |  v0.1.7 | A Wing library for working with [AWS Budgets]  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [Cloud checks](/docs/winglibs/winglibs/checks) | [@winglibs/checks](/docs/winglibs/winglibs/checks) |  v0.0.18 | A self-validation mechanism for cloud applications  | [*](/docs/platforms/platforms) |
+| [cloudv2](/docs/winglibs/winglibs/cloudv2) | [@winglibs/cloudv2](/docs/winglibs/winglibs/cloudv2) |  v0.1.2 | Standard cloud library for Wing  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
 | [Amazon Cognito](/docs/winglibs/winglibs/cognito) | [@winglibs/cognito](/docs/winglibs/winglibs/cognito) |  v0.0.14 | A wing library to work with Amazon Cognito  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
 | [Containers](/docs/winglibs/winglibs/containers) | [@winglibs/containers](/docs/winglibs/winglibs/containers) |  v0.1.6 | Deploy containers with Wing  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [Amazon DynamoDB](/docs/winglibs/winglibs/dynamodb) | [@winglibs/dynamodb](/docs/winglibs/winglibs/dynamodb) |  v0.2.2 | A Wing library for Amazon DynamoDB  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [Amazon EventBridge](/docs/winglibs/winglibs/eventbridge) | [@winglibs/eventbridge](/docs/winglibs/winglibs/eventbridge) |  v0.1.7 | A Wing library for working with Amazon EventBridge  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws), [awscdk](/docs/platforms/AWS/awscdk) |
-| [FIFO Queue](/docs/winglibs/winglibs/fifoqueue) | [@winglibs/fifoqueue](/docs/winglibs/winglibs/fifoqueue) |  v0.0.11 | A wing library to work with FIFO (first-in first-out) Queues  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [GitHub](/docs/winglibs/winglibs/github) | [@winglibs/github](/docs/winglibs/winglibs/github) |  v0.0.15 | A wing library to work with GitHub Probot  | [*](/docs/platforms/platforms) |
-| [JWT authentication](/docs/winglibs/winglibs/jwt) | [@winglibs/jwt](/docs/winglibs/winglibs/jwt) |  v0.0.8 | Wing library for JWT authentication  | [*](/docs/platforms/platforms) |
-| [Kubernetes (k8s)](/docs/winglibs/winglibs/k8s) | [@winglibs/k8s](/docs/winglibs/winglibs/k8s) |  v0.0.9 | Wing for Kubernetes  | k8s |
-| [Lock](/docs/winglibs/winglibs/lock) | [@winglibs/lock](/docs/winglibs/winglibs/lock) |  v0.0.7 | Wing library for cloud lock  | [*](/docs/platforms/platforms) |
-| [Message Fanout](/docs/winglibs/winglibs/messagefanout) | [@winglibs/messagefanout](/docs/winglibs/winglibs/messagefanout) |  v0.0.8 | Wing library to fan out messages  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [Momento](/docs/winglibs/winglibs/momento) | [@winglibs/momento](/docs/winglibs/winglibs/momento) |  v0.0.5 | Wing library for [momento](https://www.gomomento.com/)  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws), [tf-gcp](/docs/platforms/google-cloud/tf-gcp), [tf-azure](/docs/platforms/microsoft-azure/tf-azure) |
-| [ngrok](/docs/winglibs/winglibs/ngrok) | [@winglibs/ngrok](/docs/winglibs/winglibs/ngrok) |  v0.0.10 | Wing library for [ngrok](https://ngrok.com/). Create local tunnels to Wing endpoints.  | [*](/docs/platforms/platforms) |
-| [OpenAI](/docs/winglibs/winglibs/openai) | [@winglibs/openai](/docs/winglibs/winglibs/openai) |  v0.0.8 | Wing library for [OpenAI](https://openai.com/)  | [*](/docs/platforms/platforms) |
-| [Postgres](/docs/winglibs/winglibs/postgres) | [@winglibs/postgres](/docs/winglibs/winglibs/postgres) |  v0.1.12 | Wing library for [Postgres](https://www.postgresql.org/)  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [Amazon DynamoDB](/docs/winglibs/winglibs/dynamodb) | [@winglibs/dynamodb](/docs/winglibs/winglibs/dynamodb) |  v0.2.3 | A Wing library for Amazon DynamoDB  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [Amazon EventBridge](/docs/winglibs/winglibs/eventbridge) | [@winglibs/eventbridge](/docs/winglibs/winglibs/eventbridge) |  v0.1.8 | A Wing library for working with Amazon EventBridge  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws), [awscdk](/docs/platforms/AWS/awscdk) |
+| [FIFO Queue](/docs/winglibs/winglibs/fifoqueue) | [@winglibs/fifoqueue](/docs/winglibs/winglibs/fifoqueue) |  v0.0.12 | A wing library to work with FIFO (first-in first-out) Queues  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [GitHub](/docs/winglibs/winglibs/github) | [@winglibs/github](/docs/winglibs/winglibs/github) |  v0.0.16 | A wing library to work with GitHub Probot  | [*](/docs/platforms/platforms) |
+| [JWT authentication](/docs/winglibs/winglibs/jwt) | [@winglibs/jwt](/docs/winglibs/winglibs/jwt) |  v0.0.9 | Wing library for JWT authentication  | [*](/docs/platforms/platforms) |
+| [Kubernetes (k8s)](/docs/winglibs/winglibs/k8s) | [@winglibs/k8s](/docs/winglibs/winglibs/k8s) |  v0.0.10 | Wing for Kubernetes  | k8s |
+| [Lock](/docs/winglibs/winglibs/lock) | [@winglibs/lock](/docs/winglibs/winglibs/lock) |  v0.0.8 | Wing library for cloud lock  | [*](/docs/platforms/platforms) |
+| [Message Fanout](/docs/winglibs/winglibs/messagefanout) | [@winglibs/messagefanout](/docs/winglibs/winglibs/messagefanout) |  v0.0.9 | Wing library to fan out messages  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [Momento](/docs/winglibs/winglibs/momento) | [@winglibs/momento](/docs/winglibs/winglibs/momento) |  v0.0.6 | Wing library for [momento](https://www.gomomento.com/)  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws), [tf-gcp](/docs/platforms/google-cloud/tf-gcp), [tf-azure](/docs/platforms/microsoft-azure/tf-azure) |
+| [ngrok](/docs/winglibs/winglibs/ngrok) | [@winglibs/ngrok](/docs/winglibs/winglibs/ngrok) |  v0.0.11 | Wing library for [ngrok](https://ngrok.com/). Create local tunnels to Wing endpoints.  | [*](/docs/platforms/platforms) |
+| [OpenAI](/docs/winglibs/winglibs/openai) | [@winglibs/openai](/docs/winglibs/winglibs/openai) |  v0.0.9 | Wing library for [OpenAI](https://openai.com/)  | [*](/docs/platforms/platforms) |
+| [Postgres](/docs/winglibs/winglibs/postgres) | [@winglibs/postgres](/docs/winglibs/winglibs/postgres) |  v0.1.13 | Wing library for [Postgres](https://www.postgresql.org/)  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
 | [Python](/docs/winglibs/winglibs/python) | [@winglibs/python](/docs/winglibs/winglibs/python) |  v0.1.4 | A Wing library for running [Python](https://www.python.org/) code in [inflight](https://www.winglang.io/docs/concepts/inflights#inflight-code).  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [React](/docs/winglibs/winglibs/react) | [@winglibs/react](/docs/winglibs/winglibs/react) |  v0.1.5 | A Wing library for [React](https://react.dev/)  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [Redis](/docs/winglibs/winglibs/redis) | [@winglibs/redis](/docs/winglibs/winglibs/redis) |  v0.0.12 | A Wing library for [Redis](https://redis.io/) ([Example](https://www.winglang.io/docs/examples/redis)) | [sim](/docs/platforms/sim) |
-| [Amazon SageMaker](/docs/winglibs/winglibs/sagemaker) | [@winglibs/sagemaker](/docs/winglibs/winglibs/sagemaker) |  v0.0.9 | The library enables owners of a trained sagemaker model, to access its Endpoints from a winglang [inflight](https://www.winglang.io/docs/concepts/inflights#inflight-code) code.  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [Amazon SES](/docs/winglibs/winglibs/ses) | [@winglibs/ses](/docs/winglibs/winglibs/ses) |  v0.0.7 | Wing library for interacting with Amazon SES.  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [Wing simulator utils](/docs/winglibs/winglibs/simtools) | [@winglibs/simtools](/docs/winglibs/winglibs/simtools) |  v0.0.5 | '[Wing simulator](https://www.winglang.io/docs/platforms/sim) utility library'  | [sim](/docs/platforms/sim) |
-| [Slack](/docs/winglibs/winglibs/slack) | [@winglibs/slack](/docs/winglibs/winglibs/slack) |  v0.1.4 | A Wing library for working with [Slack](https://slack.com/)  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [Amazon SNS](/docs/winglibs/winglibs/sns) | [@winglibs/sns](/docs/winglibs/winglibs/sns) |  v0.1.6 | A Wing library for working with [Amazon SNS](https://aws.amazon.com/sns/)  | [tf-aws](/docs/platforms/AWS/tf-aws), [awscdk](/docs/platforms/AWS/awscdk), [sim](/docs/platforms/sim) |
-| [Terraform utilities](/docs/winglibs/winglibs/tf) | [@winglibs/tf](/docs/winglibs/winglibs/tf) |  v0.0.8 | Terraform utilities library for Wing  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [tsoa](/docs/winglibs/winglibs/tsoa) | [@winglibs/tsoa](/docs/winglibs/winglibs/tsoa) |  v0.1.14 | A Wing library for working with [TSOA](https://tsoa-community.github.io/docs/) - An OpenAPI-compliant Web APIs using TypeScript.  | [sim](/docs/platforms/sim) |
-| [Vite](/docs/winglibs/winglibs/vite) | [@winglibs/vite](/docs/winglibs/winglibs/vite) |  v0.2.4 | A Wing library to deploy [Vite applications](https://vitejs.dev/) to the cloud.  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [WebSocket](/docs/winglibs/winglibs/websockets) | [@winglibs/websockets](/docs/winglibs/winglibs/websockets) |  v0.3.12 | A Wing library that enables you to create WebSockets using Wing.  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws), [awscdk](/docs/platforms/AWS/awscdk) |
+| [React](/docs/winglibs/winglibs/react) | [@winglibs/react](/docs/winglibs/winglibs/react) |  v0.1.6 | A Wing library for [React](https://react.dev/)  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [Redis](/docs/winglibs/winglibs/redis) | [@winglibs/redis](/docs/winglibs/winglibs/redis) |  v0.0.13 | A Wing library for [Redis](https://redis.io/) ([Example](https://www.winglang.io/docs/examples/redis)) | [sim](/docs/platforms/sim) |
+| [Amazon SageMaker](/docs/winglibs/winglibs/sagemaker) | [@winglibs/sagemaker](/docs/winglibs/winglibs/sagemaker) |  v0.0.10 | The library enables owners of a trained sagemaker model, to access its Endpoints from a winglang [inflight](https://www.winglang.io/docs/concepts/inflights#inflight-code) code.  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [Amazon SES](/docs/winglibs/winglibs/ses) | [@winglibs/ses](/docs/winglibs/winglibs/ses) |  v0.0.8 | Wing library for interacting with Amazon SES.  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [Wing simulator utils](/docs/winglibs/winglibs/simtools) | [@winglibs/simtools](/docs/winglibs/winglibs/simtools) |  v0.0.6 | '[Wing simulator](https://www.winglang.io/docs/platforms/sim) utility library'  | [sim](/docs/platforms/sim) |
+| [Slack](/docs/winglibs/winglibs/slack) | [@winglibs/slack](/docs/winglibs/winglibs/slack) |  v0.1.5 | A Wing library for working with [Slack](https://slack.com/)  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [Amazon SNS](/docs/winglibs/winglibs/sns) | [@winglibs/sns](/docs/winglibs/winglibs/sns) |  v0.1.7 | A Wing library for working with [Amazon SNS](https://aws.amazon.com/sns/)  | [tf-aws](/docs/platforms/AWS/tf-aws), [awscdk](/docs/platforms/AWS/awscdk), [sim](/docs/platforms/sim) |
+| [Terraform utilities](/docs/winglibs/winglibs/tf) | [@winglibs/tf](/docs/winglibs/winglibs/tf) |  v0.0.9 | Terraform utilities library for Wing  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [tsoa](/docs/winglibs/winglibs/tsoa) | [@winglibs/tsoa](/docs/winglibs/winglibs/tsoa) |  v0.1.15 | A Wing library for working with [TSOA](https://tsoa-community.github.io/docs/) - An OpenAPI-compliant Web APIs using TypeScript.  | [sim](/docs/platforms/sim) |
+| [Vite](/docs/winglibs/winglibs/vite) | [@winglibs/vite](/docs/winglibs/winglibs/vite) |  v0.2.5 | A Wing library to deploy [Vite applications](https://vitejs.dev/) to the cloud.  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [WebSocket](/docs/winglibs/winglibs/websockets) | [@winglibs/websockets](/docs/winglibs/winglibs/websockets) |  v0.3.13 | A Wing library that enables you to create WebSockets using Wing.  | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws), [awscdk](/docs/platforms/AWS/awscdk) |
 
 ## Contributing to winglibs
 

diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/bedrock.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/bedrock.md
@@ -65,47 +65,51 @@ handled by the mocked service.
 This library is licensed under the [MIT License](./LICENSE).
 
 ---
-<h2>API Reference</h2>
+## API Reference
 
-<h3>Table of Contents</h3>
+### Table of Contents
 
 - **Classes**
   - <a href="#@winglibs/bedrock.JokeMaker">JokeMaker</a>
   - <a href="#@winglibs/bedrock.Model">Model</a>
 
-<h3 id="@winglibs/bedrock.JokeMaker">JokeMaker (preflight class)</h3>
+### JokeMaker (preflight class) <a class="wing-docs-anchor" id="@winglibs/bedrock.JokeMaker"></a>
 
-<h4>Constructor</h4>
+*No description*
 
-<pre>
+#### Constructor
+
+```
 new(): JokeMaker
-</pre>
+```
 
-<h4>Properties</h4>
+#### Properties
 
 *No properties*
 
-<h4>Methods</h4>
+#### Methods
 
 | **Signature** | **Description** |
 | --- | --- |
 | <code>inflight makeJoke(topic: str): str</code> | *No description* |
 
-<h3 id="@winglibs/bedrock.Model">Model (preflight class)</h3>
+### Model (preflight class) <a class="wing-docs-anchor" id="@winglibs/bedrock.Model"></a>
 
-<h4>Constructor</h4>
+*No description*
 
-<pre>
+#### Constructor
+
+```
 new(modelId: str): Model
-</pre>
+```
 
-<h4>Properties</h4>
+#### Properties
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code>modelId</code> | <code>str</code> | *No description* |
 
-<h4>Methods</h4>
+#### Methods
 
 | **Signature** | **Description** |
 | --- | --- |

diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/budget.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/budget.md
@@ -49,9 +49,9 @@ You get an alert when your monthly payment goes over your budget.
 This library is licensed under the [MIT License](./LICENSE).
 
 ---
-<h2>API Reference</h2>
+## API Reference
 
-<h3>Table of Contents</h3>
+### Table of Contents
 
 - **Classes**
   - <a href="#@winglibs/budget.Alert">Alert</a>
@@ -65,85 +65,97 @@ This library is licensed under the [MIT License](./LICENSE).
 - **Enums**
   - <a href="#@winglibs/budget.TimeUnit">TimeUnit</a>
 
-<h3 id="@winglibs/budget.Alert">Alert (preflight class)</h3>
+### Alert (preflight class) <a class="wing-docs-anchor" id="@winglibs/budget.Alert"></a>
 
-<h4>Constructor</h4>
+*No description*
 
-<pre>
+#### Constructor
+
+```
 new(props: AlertProps): Alert
-</pre>
+```
 
-<h4>Properties</h4>
+#### Properties
 
 *No properties*
 
-<h4>Methods</h4>
+#### Methods
 
 *No methods*
 
-<h3 id="@winglibs/budget.AlertTfAws">AlertTfAws (preflight class)</h3>
+### AlertTfAws (preflight class) <a class="wing-docs-anchor" id="@winglibs/budget.AlertTfAws"></a>
+
+*No description*
 
-<h4>Constructor</h4>
+#### Constructor
 
-<pre>
+```
 new(props: AlertProps): AlertTfAws
-</pre>
+```
 
-<h4>Properties</h4>
+#### Properties
 
 *No properties*
 
-<h4>Methods</h4>
+#### Methods
 
 *No methods*
 
-<h3 id="@winglibs/budget.AlertSim">AlertSim (preflight class)</h3>
+### AlertSim (preflight class) <a class="wing-docs-anchor" id="@winglibs/budget.AlertSim"></a>
 
-<h4>Constructor</h4>
+*No description*
 
-<pre>
+#### Constructor
+
+```
 new(props: AlertProps): AlertSim
-</pre>
+```
 
-<h4>Properties</h4>
+#### Properties
 
 *No properties*
 
-<h4>Methods</h4>
+#### Methods
 
 *No methods*
 
-<h3 id="@winglibs/budget.Util">Util (preflight class)</h3>
+### Util (preflight class) <a class="wing-docs-anchor" id="@winglibs/budget.Util"></a>
+
+*No description*
 
-<h4>Constructor</h4>
+#### Constructor
 
-<pre>
+```
 new(): Util
-</pre>
+```
 
-<h4>Properties</h4>
+#### Properties
 
 *No properties*
 
-<h4>Methods</h4>
+#### Methods
 
 | **Signature** | **Description** |
 | --- | --- |
 | <code>static timeUnitToStr(timeUnit: TimeUnit): str</code> | *No description* |
 
-<h3 id="@winglibs/budget.IAlert">IAlert (interface)</h3>
+### IAlert (interface) <a class="wing-docs-anchor" id="@winglibs/budget.IAlert"></a>
 
-<h4>Properties</h4>
+*No description*
+
+#### Properties
 
 *No properties*
 
-<h4>Methods</h4>
+#### Methods
 
 *No methods*
 
-<h3 id="@winglibs/budget.AlertProps">AlertProps (struct)</h3>
+### AlertProps (struct) <a class="wing-docs-anchor" id="@winglibs/budget.AlertProps"></a>
+
+*No description*
 
-<h4>Properties</h4>
+#### Properties
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
@@ -152,9 +164,11 @@ new(): Util
 | <code>name</code> | <code>str</code> | *No description* |
 | <code>timeUnit</code> | <code>TimeUnit?</code> | *No description* |
 
-<h3 id="@winglibs/budget.TimeUnit">TimeUnit (enum)</h3>
+### TimeUnit (enum) <a class="wing-docs-anchor" id="@winglibs/budget.TimeUnit"></a>
+
+*No description*
 
-<h4>Values</h4>
+#### Values
 
 | **Name** | **Description** |
 | --- | --- |