Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Jul 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion bedrock/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion budget/README.md
Original file line number Diff 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
6 changes: 5 additions & 1 deletion budget/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@
"platforms": [
"sim",
"tf-aws"
]
],
"docs": {
"title": "AWS Budget",
"summary": "A Wing library for working with [AWS Budgets]"
}
}
}
6 changes: 5 additions & 1 deletion checks/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,11 @@
"wing": {
"platforms": [
"*"
]
],
"docs": {
"title": "Cloud checks",
"summary": "A self-validation mechanism for cloud applications"
}
},
"license": "MIT"
}
6 changes: 5 additions & 1 deletion cognito/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,11 @@
"platforms": [
"sim",
"tf-aws"
]
],
"docs": {
"title": "Amazon Cognito",
"summary": "A wing library to work with Amazon Cognito"
}
},
"license": "MIT"
}
6 changes: 5 additions & 1 deletion containers/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@
"platforms": [
"sim",
"tf-aws"
]
],
"docs": {
"title": "Containers",
"summary": "Deploy containers with Wing"
}
},
"license": "MIT",
"peerDependencies": {
Expand Down
6 changes: 5 additions & 1 deletion dynamodb/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,11 @@
"platforms": [
"sim",
"tf-aws"
]
],
"docs": {
"title": "Amazon DynamoDB",
"summary": "A Wing library for Amazon DynamoDB"
}
},
"license": "MIT",
"peerDependencies": {
Expand Down
6 changes: 5 additions & 1 deletion eventbridge/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
6 changes: 5 additions & 1 deletion fifoqueue/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
6 changes: 5 additions & 1 deletion github/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
6 changes: 5 additions & 1 deletion jwt/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@
"wing": {
"platforms": [
"*"
]
],
"docs": {
"title": "JWT authentication",
"summary": "Wing library for JWT authentication"
}
},
"license": "MIT",
"peerDependencies": {
Expand Down
6 changes: 5 additions & 1 deletion k8s/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@
"wing": {
"platforms": [
"k8s"
]
],
"docs": {
"title": "Kubernetes (k8s)",
"summary": "Wing for Kubernetes"
}
},
"license": "MIT",
"peerDependencies": {
Expand Down
6 changes: 5 additions & 1 deletion lock/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@
"wing": {
"platforms": [
"*"
]
],
"docs": {
"title": "Lock",
"summary": "Wing library for cloud lock"
}
},
"license": "MIT"
}
6 changes: 5 additions & 1 deletion messagefanout/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
6 changes: 5 additions & 1 deletion momento/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
6 changes: 5 additions & 1 deletion ngrok/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
6 changes: 5 additions & 1 deletion openai/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@
"wing": {
"platforms": [
"*"
]
],
"docs": {
"title": "OpenAI",
"summary": "Wing library for [OpenAI](https://openai.com/)"
}
},
"peerDependencies": {
"openai": "^4.28.4"
Expand Down
6 changes: 5 additions & 1 deletion postgres/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,11 @@
"platforms": [
"sim",
"tf-aws"
]
],
"docs": {
"title": "Postgres",
"summary": "Wing library for [Postgres](https://www.postgresql.org/)"
}
},
"license": "MIT"
}
6 changes: 5 additions & 1 deletion python/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
6 changes: 5 additions & 1 deletion react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@
"platforms": [
"sim",
"tf-aws"
]
],
"docs": {
"title": "React",
"summary": "A Wing library for [React](https://react.dev/)"
}
},
"license": "MIT",
"peerDependencies": {
Expand Down
7 changes: 6 additions & 1 deletion redis/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
6 changes: 5 additions & 1 deletion sagemaker/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
6 changes: 5 additions & 1 deletion ses/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@
"platforms": [
"sim",
"tf-aws"
]
],
"docs": {
"title": "Amazon SES",
"summary": "Wing library for interacting with Amazon SES."
}
},
"license": "MIT",
"peerDependencies": {
Expand Down
6 changes: 5 additions & 1 deletion simtools/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
6 changes: 5 additions & 1 deletion slack/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@
"platforms": [
"sim",
"tf-aws"
]
],
"docs": {
"title": "Slack",
"summary": "A Wing library for working with [Slack](https://slack.com/)"
}
},
"license": "MIT"
}
2 changes: 1 addition & 1 deletion sns/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
8 changes: 6 additions & 2 deletions sns/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -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": {
Expand Down
6 changes: 5 additions & 1 deletion tf/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@
"platforms": [
"sim",
"tf-aws"
]
],
"docs": {
"title": "Terraform utilities",
"summary": "Terraform utilities library for Wing"
}
},
"license": "MIT",
"peerDependencies": {
Expand Down
6 changes: 5 additions & 1 deletion tsoa/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
6 changes: 5 additions & 1 deletion vite/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Loading
Loading