chore: update doc (#189)

Because

- there are typos in doc

This commit

- fix typos from PR 914 in the repo of instill.tech

ai/anthropic/v0/README.mdx

@@ -30,7 +30,7 @@ The component configuration is defined and maintained [here](https://github.com/
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |
-| API Key (required) | `api-key` | string | Fill your Anthropic API key. To find your keys, visit the Anthropic console page. |
+| API Key (required) | `api-key` | string | Fill in your Anthropic API key. To find your keys, visit the Anthropic console page. |
 
 
 
@@ -45,9 +45,9 @@ Provide text outputs in response to text inputs.
 | Input | ID | Type | Description |
 | :--- | :--- | :--- | :--- |
 | Task ID (required) | `task` | string | `TASK_TEXT_GENERATION_CHAT` |
-| Model Name (required) | `model-name` | string | The Anthropic model to be used. |
+| Model Name (required) | `model-name` | string | The Anthropic model to be used |
 | Prompt (required) | `prompt` | string | The prompt text |
-| System message | `system-message` | string | The system message helps set the behavior of the assistant. For example, you can modify the personality of the assistant or provide specific instructions about how it should behave throughout the conversation. By default, the model’s behavior is using a generic message as "You are a helpful assistant." |
+| System message | `system-message` | string | The system message helps set the behavior of the assistant. For example, you can modify the personality of the assistant or provide specific instructions about how it should behave throughout the conversation. By default, the model’s behavior is set using a generic message as "You are a helpful assistant." |
 | Prompt Images | `prompt-images` | array[string] | The prompt images (Note: The prompt images will be injected in the order they are provided to the 'prompt' message. Anthropic doesn't support sending images via image-url, use this field instead) |
 | Chat history | `chat-history` | array[object] | Incorporate external chat history, specifically previous messages within the conversation. Please note that System Message will be ignored and will not have any effect when this field is populated. Each message should adhere to the format: : \{"role": "The message role, i.e. 'system', 'user' or 'assistant'", "content": "message content"\}. |
 | Seed | `seed` | integer | The seed (Note: Not supported by Anthropic Models) |

ai/anthropic/v0/config/setup.json

@@ -3,7 +3,7 @@
   "additionalProperties": true,
   "properties": {
     "api-key": {
-      "description": "Fill your Anthropic API key. To find your keys, visit the Anthropic console page.",
+      "description": "Fill in your Anthropic API key. To find your keys, visit the Anthropic console page.",
       "instillUpstreamTypes": [
         "reference"
       ],

ai/anthropic/v0/config/tasks.json

@@ -137,7 +137,7 @@
             "claude-3-haiku-20240307"
           ],
           "example": "claude-3-5-sonnet-20240620",
-          "description": "The Anthropic model to be used.",
+          "description": "The Anthropic model to be used",
           "instillAcceptFormats": [
             "string"
           ],
@@ -206,7 +206,7 @@
         },
         "system-message": {
           "default": "You are a helpful assistant.",
-          "description": "The system message helps set the behavior of the assistant. For example, you can modify the personality of the assistant or provide specific instructions about how it should behave throughout the conversation. By default, the model\u2019s behavior is using a generic message as \"You are a helpful assistant.\"",
+          "description": "The system message helps set the behavior of the assistant. For example, you can modify the personality of the assistant or provide specific instructions about how it should behave throughout the conversation. By default, the model\u2019s behavior is set using a generic message as \"You are a helpful assistant.\"",
           "instillAcceptFormats": [
             "string"
           ],

application/email/v0/.compogen/extra-intro.mdx

@@ -1,2 +1,2 @@
-You can connect different email server through Email component.
+You can connect to different email servers through the Email component.
 Emails are fetched and sent using the IMAP and SMTP protocols, respectively. You can set the server address and port for each protocol in the component configuration.

application/email/v0/README.mdx

@@ -5,13 +5,13 @@ draft: false
 description: "Learn about how to set up a VDP Email component https://github.com/instill-ai/instill-core"
 ---
 
-The Email component is a application component that allows users to get and send email from Mail Protocol.
+The Email component is an application component that allows users to get and send email from Mail Protocol.
 It can carry out the following tasks:
 
 - [Send Email](#send-email)
 - [Read Emails](#read-emails)
 
-You can connect different email server through Email component.
+You can connect to different email servers through the Email component.
 Emails are fetched and sent using the IMAP and SMTP protocols, respectively. You can set the server address and port for each protocol in the component configuration.
 
 
@@ -35,8 +35,8 @@ The component configuration is defined and maintained [here](https://github.com/
 | :--- | :--- | :--- | :--- |
 | Server Address (required) | `server-address` | string | The address of the email server |
 | Server Port (required) | `server-port` | integer | The port of the email server |
-| Email Address (required) | `email-address` | string | Email address of the user |
-| App Password (required) | `password` | string | Password of the App passwords in Gmail settings |
+| Email Address (required) | `email-address` | string | The email address of the user |
+| App Password (required) | `password` | string | The password of the App passwords in Gmail settings |
 
 Supported Provider Samples for Sending Email
 
@@ -101,7 +101,7 @@ Read emails from a mailbox
 | Input | ID | Type | Description |
 | :--- | :--- | :--- | :--- |
 | Task ID (required) | `task` | string | `TASK_READ_EMAILS` |
-| Search | `search` | object | the search criteria for the emails |
+| Search | `search` | object | The search criteria for the emails |
 
 
 

application/email/v0/config/setup.json

@@ -4,7 +4,7 @@
   "properties": {
     "email-address": {
       "type": "string",
-      "description": "Email address of the user",
+      "description": "The email address of the user",
       "instillUpstreamTypes": [
         "reference",
         "value"
@@ -18,7 +18,7 @@
     },
     "password": {
       "type": "string",
-      "description": "Password of the App passwords in Gmail settings",
+      "description": "The password of the App passwords in Gmail settings",
       "instillUpstreamTypes": [
         "reference"
       ],

application/email/v0/config/tasks.json

@@ -208,7 +208,7 @@
       ],
       "properties": {
         "search": {
-          "description": "the search criteria for the emails",
+          "description": "The search criteria for the emails",
           "instillUIOrder": 0,
           "properties": {
             "mailbox": {

application/googlesearch/v0/README.mdx

@@ -5,7 +5,7 @@ draft: false
 description: "Learn about how to set up a VDP Google Search component https://github.com/instill-ai/instill-core"
 ---
 
-The Google Search component is a application component that allows users to leverage the Google Search engine.
+The Google Search component is an application component that allows users to leverage the Google Search engine.
 It can carry out the following tasks:
 
 - [Search](#search)

application/numbers/v0/README.mdx

@@ -5,7 +5,7 @@ draft: false
 description: "Learn about how to set up a VDP Numbers Protocol component https://github.com/instill-ai/instill-core"
 ---
 
-The Numbers Protocol component is a application component that allows users to seamlessly integrate third-party blockchain services through the Numbers Protocol, providing security, verifiability and traceability to data management.
+The Numbers Protocol component is an application component that allows users to seamlessly integrate third-party blockchain services through the Numbers Protocol, providing security, verifiability and traceability to data management.
 It can carry out the following tasks:
 
 - [Register](#register)

application/restapi/v0/README.mdx

@@ -5,7 +5,7 @@ draft: false
 description: "Learn about how to set up a VDP REST API component https://github.com/instill-ai/instill-core"
 ---
 
-The REST API component is a application component that allows users to make requests to external REST APIs.
+The REST API component is an application component that allows users to make requests to external REST APIs.
 It can carry out the following tasks:
 
 - [Get](#get)

application/slack/v0/README.mdx

@@ -5,7 +5,7 @@ draft: false
 description: "Learn about how to set up a VDP Slack component https://github.com/instill-ai/instill-core"
 ---
 
-The Slack component is a application component that allows users to get and send message on Slack.
+The Slack component is an application component that allows users to get and send message on Slack.
 It can carry out the following tasks:
 
 - [Read Message](#read-message)

application/website/v0/README.mdx

@@ -5,7 +5,7 @@ draft: false
 description: "Learn about how to set up a VDP Website component https://github.com/instill-ai/instill-core"
 ---
 
-The Website component is a application component that allows users to scrape websites.
+The Website component is an application component that allows users to scrape websites.
 It can carry out the following tasks:
 
 - [Scrape Website](#scrape-website)

data/bigquery/v0/README.mdx

@@ -70,7 +70,7 @@ Read data from BigQuery.
 | Input | ID | Type | Description |
 | :--- | :--- | :--- | :--- |
 | Task ID (required) | `task` | string | `TASK_READ` |
-| Filtering | `filtering` | string | The filter to be applied to the data, please start with where clause |
+| Filtering | `filtering` | string | The filter to be applied to the data with SQL syntax, which starts with WHERE clause |
 
 
 

data/bigquery/v0/config/tasks.json

@@ -43,7 +43,7 @@
       "properties": {
         "filtering": {
           "instillShortDescription": "The filter to be applied to the data",
-          "description": "The filter to be applied to the data, please start with where clause",
+          "description": "The filter to be applied to the data with SQL syntax, which starts with WHERE clause",
           "instillUIOrder": 0,
           "required": [],
           "title": "Filtering",

data/googlecloudstorage/v0/README.mdx

@@ -47,7 +47,7 @@ Upload data to Google Cloud Storage.
 | Input | ID | Type | Description |
 | :--- | :--- | :--- | :--- |
 | Task ID (required) | `task` | string | `TASK_UPLOAD` |
-| Bucket Name (required) | `bucket-name` | string | Name of the bucket to be used for object storage. |
+| Bucket Name (required) | `bucket-name` | string | Name of the bucket to be used for object storage |
 | Object Name (required) | `object-name` | string | The name of the object to be created |
 | Data (required) | `data` | string | The data to be saved in the object |
 
@@ -74,7 +74,7 @@ Read objects from Google Cloud Storage.
 | Input | ID | Type | Description |
 | :--- | :--- | :--- | :--- |
 | Task ID (required) | `task` | string | `TASK_READ_OBJECTS` |
-| Bucket Name (required) | `bucket-name` | string | Name of the bucket to be used for object storage. |
+| Bucket Name (required) | `bucket-name` | string | Name of the bucket to be used for object storage |
 | Delimiter | `delimiter` | string | The delimiter to use when listing objects |
 | Prefix | `prefix` | string | The prefix to use when listing objects |
 | Versions | `versions` | boolean | Whether to list all versions of an object |
@@ -107,7 +107,7 @@ Read objects from Google Cloud Storage.
 | Input | ID | Type | Description |
 | :--- | :--- | :--- | :--- |
 | Task ID (required) | `task` | string | `TASK_CREATE_BUCKET` |
-| Bucket Name (required) | `bucket-name` | string | Name of the bucket to be used for object storage. |
+| Bucket Name (required) | `bucket-name` | string | Name of the bucket to be used for object storage |
 | Project ID (required) | `project-id` | string | The project ID to create the bucket in |
 | Location | `location` | string | The location to create the bucket in |
 

data/googlecloudstorage/v0/config/tasks.json

@@ -1,7 +1,7 @@
 {
   "$defs": {
     "bucket-name": {
-      "description": "Name of the bucket to be used for object storage.",
+      "description": "Name of the bucket to be used for object storage",
       "instillUpstreamTypes": [
         "value",
         "reference"

data/pinecone/v0/README.mdx

@@ -31,7 +31,7 @@ The component configuration is defined and maintained [here](https://github.com/
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |
-| API Key (required) | `api-key` | string | Fill in your Pinecone AI API key. You can create a api key in Pinecone Console |
+| API Key (required) | `api-key` | string | Fill in your Pinecone AI API key. You can create an api key in Pinecone Console |
 | Pinecone Base URL (required) | `url` | string | Fill in your Pinecone base URL. It is in the form |
 
 

data/pinecone/v0/config/setup.json

@@ -3,7 +3,7 @@
   "additionalProperties": false,
   "properties": {
     "api-key": {
-      "description": "Fill in your Pinecone AI API key. You can create a api key in Pinecone Console",
+      "description": "Fill in your Pinecone AI API key. You can create an api key in Pinecone Console",
       "instillUpstreamTypes": [
         "reference"
       ],

tools/compogen/pkg/gen/component_type.go

@@ -23,8 +23,9 @@ var toComponentType = map[string]ComponentType{
 }
 
 var modifiesArticle = map[ComponentType]bool{
-	cstOperator: true,
-	cstAI:       true,
+	cstOperator:    true,
+	cstAI:          true,
+	cstApplication: true,
 }
 
 // IndefiniteArticle returns the correct indefinite article (in English) for a

tools/compogen/pkg/gen/readme_test.go

@@ -35,7 +35,7 @@ func TestComponentType_IndefiniteArticle(t *testing.T) {
 	}{
 		{in: cstOperator, want: "an"},
 		{in: cstAI, want: "an"},
-		{in: cstApplication, want: "a"},
+		{in: cstApplication, want: "an"},
 		{in: cstData, want: "a"},
 	}