docs(docs): added new docs attribute to each winglib package file (#302)

* adding docs for winglibs for doc automation on docsite * adding docs for winglibs for doc automation on docsite --------- Co-authored-by: David Boyne <[email protected]>
winglang · Jul 31, 2024 · e92821d · e92821d
1 parent 5df2901
commit e92821d
Show file tree

Hide file tree

Showing 31 changed files with 150 additions and 32 deletions.
diff --git a/bedrock/package.json b/bedrock/package.json
@@ -16,7 +16,12 @@
     "platforms": [
       "sim",
       "tf-aws"
-    ]
+    ],
+    "docs": {
+      "title": "Amazon Bedrock",
+      "summary": "A Wing library for Amazon Bedrock",
+      "demoURL": "http://winglang.io/docs/examples/basic-auth-api"
+    }
   },
   "peerDependencies": {
     "@aws-sdk/client-bedrock-runtime": "^3.484.0"

diff --git a/budget/README.md b/budget/README.md
@@ -18,7 +18,7 @@ npm i @winglibs/budget
 
 Add your budget alert to the code:
 
-```wing
+```js
 bring budget;
 
 new budget.Alert(

diff --git a/budget/package.json b/budget/package.json
@@ -24,6 +24,10 @@
     "platforms": [
       "sim",
       "tf-aws"
-    ]
+    ],
+    "docs": {
+      "title": "AWS Budget",
+      "summary": "A Wing library for working with [AWS Budgets]"
+    }
   }
 }
diff --git a/checks/package.json b/checks/package.json
@@ -23,7 +23,11 @@
   "wing": {
     "platforms": [
       "*"
-    ]
+    ],
+    "docs": {
+      "title": "Cloud checks",
+      "summary": "A self-validation mechanism for cloud applications"
+    }
   },
   "license": "MIT"
 }
diff --git a/cognito/package.json b/cognito/package.json
@@ -21,7 +21,11 @@
     "platforms": [
       "sim",
       "tf-aws"
-    ]
+    ],
+    "docs": {
+      "title": "Amazon Cognito",
+      "summary": "A wing library to work with Amazon Cognito"
+    }
   },
   "license": "MIT"
 }
diff --git a/containers/package.json b/containers/package.json
@@ -15,7 +15,11 @@
     "platforms": [
       "sim",
       "tf-aws"
-    ]
+    ],
+    "docs": {
+      "title": "Containers",
+      "summary": "Deploy containers with Wing"
+    }
   },
   "license": "MIT",
   "peerDependencies": {

diff --git a/dynamodb/package.json b/dynamodb/package.json
@@ -19,7 +19,11 @@
     "platforms": [
       "sim",
       "tf-aws"
-    ]
+    ],
+    "docs": {
+      "title": "Amazon DynamoDB",
+      "summary": "A Wing library for Amazon DynamoDB"
+    }
   },
   "license": "MIT",
   "peerDependencies": {

diff --git a/eventbridge/package.json b/eventbridge/package.json
@@ -17,7 +17,11 @@
       "sim",
       "tf-aws",
       "awscdk"
-    ]
+    ],
+    "docs": {
+      "title": "Amazon EventBridge",
+      "summary": "A Wing library for working with Amazon EventBridge"
+    }
   },
   "peerDependencies": {
     "@aws-sdk/client-eventbridge": "^3.525.0",

diff --git a/fifoqueue/package.json b/fifoqueue/package.json
@@ -20,7 +20,11 @@
     "platforms": [
       "sim",
       "tf-aws"
-    ]
+    ],
+    "docs": {
+      "title": "FIFO Queue",
+      "summary": "A wing library to work with FIFO (first-in first-out) Queues"
+    }
   },
   "license": "MIT"
 }
diff --git a/github/package.json b/github/package.json
@@ -15,7 +15,11 @@
   "wing": {
     "platforms": [
       "*"
-    ]
+    ],
+    "docs": {
+      "title": "GitHub",
+      "summary": "A wing library to work with GitHub Probot"
+    }
   },
   "peerDependencies": {
     "@probot/adapter-aws-lambda-serverless": "^3.0.4",

diff --git a/jwt/package.json b/jwt/package.json
@@ -14,7 +14,11 @@
   "wing": {
     "platforms": [
       "*"
-    ]
+    ],
+    "docs": {
+      "title": "JWT authentication",
+      "summary": "Wing library for JWT authentication"
+    }
   },
   "license": "MIT",
   "peerDependencies": {

diff --git a/k8s/package.json b/k8s/package.json
@@ -14,7 +14,11 @@
   "wing": {
     "platforms": [
       "k8s"
-    ]
+    ],
+    "docs": {
+      "title": "Kubernetes (k8s)",
+      "summary": "Wing for Kubernetes"
+    }
   },
   "license": "MIT",
   "peerDependencies": {

diff --git a/lock/package.json b/lock/package.json
@@ -14,7 +14,11 @@
   "wing": {
     "platforms": [
       "*"
-    ]
+    ],
+    "docs": {
+      "title": "Lock",
+      "summary": "Wing library for cloud lock"
+    }
   },
   "license": "MIT"
 }
diff --git a/messagefanout/package.json b/messagefanout/package.json
@@ -16,7 +16,11 @@
     "platforms": [
       "sim",
       "tf-aws"
-    ]
+    ],
+    "docs": {
+      "title": "Message Fanout",
+      "summary": "Wing library to fan out messages"
+    }
   },
   "peerDependencies": {
     "@aws-sdk/client-sns": "^3.511.0",

diff --git a/momento/package.json b/momento/package.json
@@ -17,7 +17,11 @@
       "tf-aws",
       "tf-gcp",
       "tf-azure"
-    ]
+    ],
+    "docs": {
+      "title": "Momento",
+      "summary": "Wing library for [momento](https://www.gomomento.com/)"
+    }
   },
   "license": "MIT",
   "peerDependencies": {

diff --git a/ngrok/package.json b/ngrok/package.json
@@ -14,7 +14,11 @@
   "wing": {
     "platforms": [
       "*"
-    ]
+    ],
+    "docs": {
+      "title": "ngrok",
+      "summary": "Wing library for [ngrok](https://ngrok.com/). Create local tunnels to Wing endpoints."
+    }
   },
   "license": "MIT",
   "peerDependencies": {

diff --git a/openai/package.json b/openai/package.json
@@ -15,7 +15,11 @@
   "wing": {
     "platforms": [
       "*"
-    ]
+    ],
+    "docs": {
+      "title": "OpenAI",
+      "summary": "Wing library for [OpenAI](https://openai.com/)"
+    }
   },
   "peerDependencies": {
     "openai": "^4.28.4"

diff --git a/postgres/package.json b/postgres/package.json
@@ -22,7 +22,11 @@
     "platforms": [
       "sim",
       "tf-aws"
-    ]
+    ],
+    "docs": {
+      "title": "Postgres",
+      "summary": "Wing library for [Postgres](https://www.postgresql.org/)"
+    }
   },
   "license": "MIT"
 }
diff --git a/python/package.json b/python/package.json
@@ -15,7 +15,11 @@
     "platforms": [
       "sim",
       "tf-aws"
-    ]
+    ],
+    "docs": {
+      "title": "Python",
+      "summary": "A Wing library for running [Python](https://www.python.org/) code in [inflight](https://www.winglang.io/docs/concepts/inflights#inflight-code)."
+    }
   },
   "license": "MIT",
   "peerDependencies": {

diff --git a/react/package.json b/react/package.json
@@ -15,7 +15,11 @@
     "platforms": [
       "sim",
       "tf-aws"
-    ]
+    ],
+    "docs": {
+      "title": "React",
+      "summary": "A Wing library for [React](https://react.dev/)"
+    }
   },
   "license": "MIT",
   "peerDependencies": {

diff --git a/redis/package.json b/redis/package.json
@@ -14,7 +14,12 @@
   "wing": {
     "platforms": [
       "sim"
-    ]
+    ],
+    "docs": {
+      "title": "Redis",
+      "summary": "A Wing library for [Redis](https://redis.io/)",
+      "demoURL": "https://www.winglang.io/docs/examples/redis"
+    }
   },
   "license": "MIT",
   "peerDependencies": {

diff --git a/sagemaker/package.json b/sagemaker/package.json
@@ -15,7 +15,11 @@
     "platforms": [
       "sim",
       "tf-aws"
-    ]
+    ],
+    "docs": {
+      "title": "Amazon SageMaker",
+      "summary": "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."
+    }
   },
   "license": "MIT",
   "peerDependencies": {

diff --git a/ses/package.json b/ses/package.json
@@ -15,7 +15,11 @@
     "platforms": [
       "sim",
       "tf-aws"
-    ]
+    ],
+    "docs": {
+      "title": "Amazon SES",
+      "summary": "Wing library for interacting with Amazon SES."
+    }
   },
   "license": "MIT",
   "peerDependencies": {

diff --git a/simtools/package.json b/simtools/package.json
@@ -14,7 +14,11 @@
   "wing": {
     "platforms": [
       "sim"
-    ]
+    ],
+    "docs": {
+      "title": "Wing simulator utils",
+      "summary": "[Wing simulator](https://www.winglang.io/docs/platforms/sim) utility library"
+    }
   },
   "license": "MIT"
 }
diff --git a/slack/package.json b/slack/package.json
@@ -18,7 +18,11 @@
     "platforms": [
       "sim",
       "tf-aws"
-    ]
+    ],
+    "docs": {
+      "title": "Slack",
+      "summary": "A Wing library for working with [Slack](https://slack.com/)"
+    }
   },
   "license": "MIT"
 }
diff --git a/sns/README.md b/sns/README.md
@@ -1,6 +1,6 @@
 # sns
 
-This library allows you to interact with the AWS SNS Service.
+This library allows you to interact with the Amazon SNS Service.
 
 ## Prerequisites
 

diff --git a/sns/package.json b/sns/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@winglibs/sns",
-  "description": "Wing library for interacting with AWS SNS",
+  "description": "Wing library for interacting with Amazon SNS",
   "version": "0.1.3",
   "repository": {
     "type": "git",
@@ -16,7 +16,11 @@
       "tf-aws",
       "awscdk",
       "sim"
-    ]
+    ],
+    "docs": {
+      "title": "Amazon SNS",
+      "summary": "A Wing library for working with [Amazon SNS](https://aws.amazon.com/sns/)"
+    }
   },
   "license": "MIT",
   "peerDependencies": {

diff --git a/tf/package.json b/tf/package.json
@@ -15,7 +15,11 @@
     "platforms": [
       "sim",
       "tf-aws"
-    ]
+    ],
+    "docs": {
+      "title": "Terraform utilities",
+      "summary": "Terraform utilities library for Wing"
+    }
   },
   "license": "MIT",
   "peerDependencies": {

diff --git a/tsoa/package.json b/tsoa/package.json
@@ -14,7 +14,11 @@
   "wing": {
     "platforms": [
       "sim"
-    ]
+    ],
+    "docs": {
+      "title": "tsoa",
+      "summary": "A Wing library for working with [TSOA](https://tsoa-community.github.io/docs/) - An OpenAPI-compliant Web APIs using TypeScript."
+    }
   },
   "license": "MIT",
   "peerDependencies": {

diff --git a/vite/package.json b/vite/package.json
@@ -21,7 +21,11 @@
     "platforms": [
       "sim",
       "tf-aws"
-    ]
+    ],
+    "docs": {
+      "title": "Vite",
+      "summary": "A Wing library to deploy [Vite applications](https://vitejs.dev/) to the cloud."
+    }
   },
   "peerDependencies": {
     "@cdktf/provider-aws": "^19.12.0",
-Original file line number
+Diff line change
@@ Expand Up / @@ -18,7 +18,7 @@ npm i @winglibs/budget @@
     Add your budget alert to the code:
-    ```wing
+    ```js
     bring budget;
     new budget.Alert(
@@ Expand Down @@