docs(agents): make Build your first Agent a complete, minimal-setup tutorial - #1133
reviewdog [vale] report
reported by reviewdog 🐶
Findings (17)
content/docs/agents/custom-code-agent/build-your-first-agent.mdx|11 col 6| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/agents/custom-code-agent/build-your-first-agent.mdx|13 col 9| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/agents/custom-code-agent/build-your-first-agent.mdx|13 col 48| [Novu.SentenceLength] Sentences should not exceed 25 words; this one has 29.
content/docs/agents/custom-code-agent/build-your-first-agent.mdx|13 col 160| [Google.Acronyms] Spell out 'LLM', if it's unfamiliar to the audience.
content/docs/agents/custom-code-agent/build-your-first-agent.mdx|13 col 203| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/agents/custom-code-agent/build-your-first-agent.mdx|13 col 203| [write-good.Passive] 'is done' may be passive voice. Use active voice if you can.
content/docs/agents/custom-code-agent/build-your-first-agent.mdx|13 col 203| [Google.Passive] In general, use active voice instead of passive voice ('is done').
content/docs/agents/custom-code-agent/build-your-first-agent.mdx|15 col 40| [write-good.TooWordy] 'minimum' is too wordy.
content/docs/agents/custom-code-agent/build-your-first-agent.mdx|31 col 1| [Novu.BulletStyle] Prefer '' over '-' for bullet points (ignore inside code fences).
content/docs/agents/custom-code-agent/build-your-first-agent.mdx|32 col 1| [Novu.BulletStyle] Prefer '' over '-' for bullet points (ignore inside code fences).
content/docs/agents/custom-code-agent/build-your-first-agent.mdx|33 col 1| [Novu.BulletStyle] Prefer '*' over '-' for bullet points (ignore inside code fences).
content/docs/agents/custom-code-agent/build-your-first-agent.mdx|48 col 28| [Google.Parens] Use parentheses judiciously.
content/docs/agents/custom-code-agent/build-your-first-agent.mdx|55 col 16| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/agents/custom-code-agent/build-your-first-agent.mdx|95 col 90| [Google.Contractions] Use 'don't' instead of 'do not'.
content/docs/agents/custom-code-agent/build-your-first-agent.mdx|95 col 208| [Google.Semicolons] Use semicolons judiciously.
content/docs/agents/custom-code-agent/build-your-first-agent.mdx|101 col 61| [Google.Acronyms] Spell out 'LLM', if it's unfamiliar to the audience.
content/docs/agents/custom-code-agent/build-your-first-agent.mdx|258 col 34| [Google.Acronyms] Spell out 'LLM', if it's unfamiliar to the audience.
Filtered Findings (13927)
content/docs/api-reference/channel-endpoints/retrieve-a-channel-endpoint.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/channel-endpoints/retrieve-a-channel-endpoint.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/channel-endpoints/retrieve-a-channel-endpoint.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/channel-endpoints/retrieve-a-channel-endpoint.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/channel-endpoints/retrieve-a-channel-endpoint.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/channel-endpoints/create-a-channel-endpoint.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/channel-endpoints/create-a-channel-endpoint.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/channel-endpoints/create-a-channel-endpoint.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/channel-endpoints/create-a-channel-endpoint.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/channel-endpoints/create-a-channel-endpoint.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/channel-endpoints/delete-a-channel-endpoint.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/channel-endpoints/delete-a-channel-endpoint.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/channel-endpoints/delete-a-channel-endpoint.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/channel-endpoints/delete-a-channel-endpoint.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/channel-endpoints/delete-a-channel-endpoint.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/channel-endpoints/list-all-channel-endpoints.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/channel-endpoints/list-all-channel-endpoints.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/channel-endpoints/list-all-channel-endpoints.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/channel-endpoints/list-all-channel-endpoints.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/channel-endpoints/list-all-channel-endpoints.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/channel-endpoints/update-a-channel-endpoint.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/channel-endpoints/update-a-channel-endpoint.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/channel-endpoints/update-a-channel-endpoint.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/channel-endpoints/update-a-channel-endpoint.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/channel-endpoints/update-a-channel-endpoint.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environment-variables/delete-a-variable.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environment-variables/delete-a-variable.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environment-variables/delete-a-variable.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environment-variables/delete-a-variable.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environment-variables/delete-a-variable.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environment-variables/list-all-variables.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environment-variables/list-all-variables.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environment-variables/list-all-variables.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environment-variables/list-all-variables.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environment-variables/list-all-variables.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environment-variables/retrieve-a-variable-usage.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environment-variables/retrieve-a-variable-usage.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environment-variables/retrieve-a-variable-usage.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environment-variables/retrieve-a-variable-usage.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environment-variables/retrieve-a-variable-usage.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environment-variables/update-a-variable.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environment-variables/update-a-variable.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environment-variables/update-a-variable.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environment-variables/update-a-variable.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environment-variables/update-a-variable.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environment-variables/retrieve-a-variable.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environment-variables/retrieve-a-variable.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environment-variables/retrieve-a-variable.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environment-variables/retrieve-a-variable.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environment-variables/retrieve-a-variable.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environment-variables/environment-variable-schema.model.mdx|7 col 5| [Google.Headings] 'Environment Variable' should use sentence-style capitalization.
content/docs/api-reference/environment-variables/environment-variable-schema.model.mdx|9 col 22| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/api-reference/environment-variables/environment-variable-schema.model.mdx|9 col 100| [Novu.SentenceLength] Sentences should not exceed 25 words; this one has 26.
content/docs/api-reference/environment-variables/environment-variable-schema.model.mdx|9 col 234| [Google.Parens] Use parentheses judiciously.
content/docs/api-reference/environment-variables/create-a-variable.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environment-variables/create-a-variable.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environment-variables/create-a-variable.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environment-variables/create-a-variable.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environment-variables/create-a-variable.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/publish-resources-to-target-environment.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environments/publish-resources-to-target-environment.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environments/publish-resources-to-target-environment.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environments/publish-resources-to-target-environment.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environments/publish-resources-to-target-environment.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/update-an-environment.mdx|18 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environments/update-an-environment.mdx|18 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environments/update-an-environment.mdx|18 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environments/update-an-environment.mdx|18 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environments/update-an-environment.mdx|20 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/list-all-environments.mdx|18 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environments/list-all-environments.mdx|18 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environments/list-all-environments.mdx|18 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environments/list-all-environments.mdx|18 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environments/list-all-environments.mdx|20 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/list-environment-tags.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environments/list-environment-tags.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environments/list-environment-tags.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environments/list-environment-tags.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environments/list-environment-tags.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/environment-schema.mdx|9 col 13| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/api-reference/environments/environment-schema.mdx|9 col 47| [write-good.Passive] 'are used' may be passive voice. Use active voice if you can.
content/docs/api-reference/environments/environment-schema.mdx|9 col 47| [write-good.E-Prime] Try to avoid using 'are'.
content/docs/api-reference/environments/environment-schema.mdx|9 col 47| [Google.Passive] In general, use active voice instead of passive voice ('are used').
content/docs/api-reference/environments/environment-schema.mdx|11 col 2| [Novu.SentenceLength] Sentences should not exceed 25 words; this one has 77.
content/docs/api-reference/environments/environment-schema.mdx|13 col 20| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/environment-schema.mdx|17 col 20| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/environment-schema.mdx|21 col 20| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/environment-schema.mdx|25 col 20| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/environment-schema.mdx|29 col 20| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/environment-schema.mdx|29 col 21| [write-good.TooWordy] 'Type of' is too wordy.
content/docs/api-reference/environments/environment-schema.mdx|33 col 20| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/environment-schema.mdx|37 col 20| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/environment-schema.mdx|41 col 20| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/create-an-environment.mdx|19 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environments/create-an-environment.mdx|19 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environments/create-an-environment.mdx|19 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environments/create-an-environment.mdx|19 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environments/create-an-environment.mdx|21 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environment-variables/environment-variable-schema.mdx|7 col 5| [Google.Headings] 'Environment Variable' should use sentence-style capitalization.
content/docs/api-reference/environment-variables/environment-variable-schema.mdx|9 col 22| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/api-reference/environment-variables/environment-variable-schema.mdx|9 col 100| [Novu.SentenceLength] Sentences should not exceed 25 words; this one has 26.
content/docs/api-reference/environment-variables/environment-variable-schema.mdx|9 col 234| [Google.Parens] Use parentheses judiciously.
content/docs/api-reference/environment-variables/environment-variable-schema.mdx|11 col 2| [Novu.SentenceLength] Sentences should not exceed 25 words; this one has 36.
content/docs/api-reference/environments/compare-resources-between-environments.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environments/compare-resources-between-environments.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environments/compare-resources-between-environments.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environments/compare-resources-between-environments.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environments/compare-resources-between-environments.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/delete-an-environment.mdx|18 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environments/delete-an-environment.mdx|18 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environments/delete-an-environment.mdx|18 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environments/delete-an-environment.mdx|18 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environments/delete-an-environment.mdx|20 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/environment-schema.model.mdx|9 col 13| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/api-reference/environments/environment-schema.model.mdx|9 col 47| [Google.Passive] In general, use active voice instead of passive voice ('are used').
content/docs/api-reference/environments/environment-schema.model.mdx|9 col 47| [write-good.Passive] 'are used' may be passive voice. Use active voice if you can.
content/docs/api-reference/environments/environment-schema.model.mdx|9 col 47| [write-good.E-Prime] Try to avoid using 'are'.
content/docs/api-reference/notifications/list-all-events.mdx|20 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/notifications/list-all-events.mdx|20 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/notifications/list-all-events.mdx|20 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/notifications/list-all-events.mdx|20 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/notifications/list-all-events.mdx|22 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/notifications/retrieve-an-event.mdx|19 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/notifications/retrieve-an-event.mdx|19 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/notifications/retrieve-an-event.mdx|19 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/notifications/retrieve-an-event.mdx|19 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/notifications/retrieve-an-event.mdx|21 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/integrations/auto-configure-an-integration-for-inbound-webhooks.mdx|18 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/integrations/auto-configure-an-integration-for-inbound-webhooks.mdx|18 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/integrations/auto-configure-an-integration-for-inbound-webhooks.mdx|18 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/integrations/auto-configure-an-integration-for-inbound-webhooks.mdx|18 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/integrations/auto-configure-an-integration-for-inbound-webhooks.mdx|20 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/integrations/update-an-integration.mdx|18 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/integrations/update-an-integration.mdx|18 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/integrations/update-an-integration.mdx|18 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/integrations/update-an-integration.mdx|18 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/integrations/update-an-integration.mdx|20 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/integrations/create-an-integration.mdx|18 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/integrations/create-an-integration.mdx|18 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/integrations/create-an-integration.mdx|18 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/integrations/create-an-integration.mdx|18 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/integrations/create-an-integration.mdx|20 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/integrations/generate-chat-oauth-url.mdx|19 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/integrations/generate-chat-oauth-url.mdx|19 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/integrations/generate-chat-oauth-url.mdx|19 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/integrations/generate-chat-oauth-url.mdx|19 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/integrations/generate-chat-oauth-url.mdx|21 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/notifications/notification-event-schema.model.mdx|9 col 20| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/api-reference/notifications/notification-event-schema.model.mdx|9 col 33| [Google.Contractions] Use 'that's' instead of 'that is'.
content/docs/api-reference/notifications/notification-event-schema.model.mdx|9 col 38| [Google.Passive] In general, use active voice instead of passive voice ('is generated').
content/docs/api-reference/notifications/notification-event-schema.model.mdx|9 col 38| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/api-reference/notifications/notification-event-schema.model.mdx|9 col 38| [write-good.Passive] 'is generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/notifications/notification-event-schema.model.mdx|9 col 67| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/api-reference/notifications/notification-event-schema.model.mdx|9 col 67| [write-good.Passive] 'is triggered' may be passive voice. Use active voice if you can.
content/docs/api-reference/notifications/notification-event-schema.model.mdx|9 col 67| [Google.Passive] In general, use active voice instead of passive voice ('is triggered').
content/docs/api-reference/notifications/notification-event-schema.model.mdx|9 col 96| [Novu.SentenceLength] Sentences should not exceed 25 words; this one has 27.
content/docs/api-reference/notifications/notification-event-schema.model.mdx|17 col 52| [Google.Passive] In general, use active voice instead of passive voice ('was triggered').
content/docs/api-reference/notifications/notification-event-schema.model.mdx|17 col 52| [write-good.Passive] 'was triggered' may be passive voice. Use active voice if you can.
content/docs/api-reference/notifications/notification-event-schema.model.mdx|17 col 52| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/notifications/notification-event-schema.model.mdx|23 col 5| [Google.Headings] 'ChannelTypeEnum' should use sentence-style capitalization.
content/docs/api-reference/notifications/notification-event-schema.model.mdx|25 col 17| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/api-reference/notifications/notification-event-schema.model.mdx|25 col 24| [write-good.TooWordy] 'type of' is too wordy.
content/docs/api-reference/notifications/notification-event-schema.model.mdx|25 col 66| [write-good.Passive] 'was sent' may be passive voice. Use active voice if you can.
content/docs/api-reference/notifications/notification-event-schema.model.mdx|25 col 66| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/notifications/notification-event-schema.model.mdx|25 col 66| [Google.Passive] In general, use active voice instead of passive voice ('was sent').
content/docs/api-reference/integrations/list-all-integrations.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/integrations/list-all-integrations.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/integrations/list-all-integrations.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/integrations/list-all-integrations.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/integrations/list-all-integrations.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/integrations/update-integration-as-primary.mdx|19 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/integrations/update-integration-as-primary.mdx|19 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/integrations/update-integration-as-primary.mdx|19 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/integrations/update-integration-as-primary.mdx|19 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/integrations/update-integration-as-primary.mdx|21 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/rate-limiting.mdx|7 col 15| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/api-reference/rate-limiting.mdx|7 col 129| [write-good.Passive] 'being misused' may be passive voice. Use active voice if you can.
content/docs/api-reference/rate-limiting.mdx|7 col 129| [write-good.E-Prime] Try to avoid using 'being'.
content/docs/api-reference/rate-limiting.mdx|7 col 129| [Google.Passive] In general, use active voice instead of passive voice ('being misused').
content/docs/api-reference/rate-limiting.mdx|7 col 166| [write-good.Passive] 'being monopolized' may be passive voice. Use active voice if you can.
content/docs/api-reference/rate-limiting.mdx|7 col 166| [write-good.E-Prime] Try to avoid using 'being'.
content/docs/api-reference/rate-limiting.mdx|7 col 166| [Google.Passive] In general, use active voice instead of passive voice ('being monopolized').
content/docs/api-reference/rate-limiting.mdx|9 col 57| [write-good.E-Prime] Try to avoid using 'been'.
content/docs/api-reference/rate-limiting.mdx|9 col 57| [Google.Passive] In general, use active voice instead of passive voice ('been added').
content/docs/api-reference/rate-limiting.mdx|9 col 57| [write-good.Passive] 'been added' may be passive voice. Use active voice if you can.
content/docs/api-reference/rate-limiting.mdx|15 col 60| [Google.Parens] Use parentheses judiciously.
content/docs/api-reference/rate-limiting.mdx|15 col 61| [Google.Acronyms] Spell out 'RPS', if it's unfamiliar to the audience.
content/docs/api-reference/rate-limiting.mdx|19 col 22| [Google.Acronyms] Spell out 'RPS', if it's unfamiliar to the audience.
content/docs/api-reference/rate-limiting.mdx|19 col 32| [Google.Acronyms] Spell out 'RPS', if it's unfamiliar to the audience.
content/docs/api-reference/rate-limiting.mdx|19 col 42| [Google.Acronyms] Spell out 'RPS', if it's unfamiliar to the audience.
content/docs/api-reference/rate-limiting.mdx|19 col 52| [Google.Acronyms] Spell out 'RPS', if it's unfamiliar to the audience.
content/docs/api-reference/rate-limiting.mdx|20 col 22| [Google.Acronyms] Spell out 'RPS', if it's unfamiliar to the audience.
content/docs/api-reference/rate-limiting.mdx|20 col 31| [Google.Acronyms] Spell out 'RPS', if it's unfamiliar to the audience.
content/docs/api-reference/rate-limiting.mdx|20 col 42| [Google.Acronyms] Spell out 'RPS', if it's unfamiliar to the audience.
content/docs/api-reference/rate-limiting.mdx|20 col 52| [Google.Acronyms] Spell out 'RPS', if it's unfamiliar to the audience.
content/docs/api-reference/rate-limiting.mdx|21 col 22| [Google.Acronyms] Spell out 'RPS', if it's unfamiliar to the audience.
content/docs/api-reference/rate-limiting.mdx|21 col 32| [Google.Acronyms] Spell out 'RPS', if it's unfamiliar to the audience.
content/docs/api-reference/rate-limiting.mdx|21 col 42| [Google.Acronyms] Spell out 'RPS', if it's unfamiliar to the audience.
content/docs/api-reference/rate-limiting.mdx|21 col 52| [Google.Acronyms] Spell out 'RPS', if it's unfamiliar to the audience.
content/docs/api-reference/rate-limiting.mdx|24 col 1| [Novu.BulletStyle] Prefer '*' over '-' for bullet points (ignore inside code fences).
content/docs/api-reference/rate-limiting.mdx|24 col 23| [Google.Parens] Use parentheses judiciously.
... (Too many findings. Dropped some findings)
Annotations
Check notice on line 11 in content/docs/agents/custom-code-agent/build-your-first-agent.mdx
github-actions / vale
[vale] content/docs/agents/custom-code-agent/build-your-first-agent.mdx#L11
[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "content/docs/agents/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 11, "column": 6}}}, "severity": "INFO"}
Check notice on line 13 in content/docs/agents/custom-code-agent/build-your-first-agent.mdx
github-actions / vale
[vale] content/docs/agents/custom-code-agent/build-your-first-agent.mdx#L13
[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "content/docs/agents/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 13, "column": 9}}}, "severity": "INFO"}
Check warning on line 13 in content/docs/agents/custom-code-agent/build-your-first-agent.mdx
github-actions / vale
[vale] content/docs/agents/custom-code-agent/build-your-first-agent.mdx#L13
[Novu.SentenceLength] Sentences should not exceed 25 words; this one has 29.
Raw output
{"message": "[Novu.SentenceLength] Sentences should not exceed 25 words; this one has 29.", "location": {"path": "content/docs/agents/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 13, "column": 48}}}, "severity": "WARNING"}
Check notice on line 13 in content/docs/agents/custom-code-agent/build-your-first-agent.mdx
github-actions / vale
[vale] content/docs/agents/custom-code-agent/build-your-first-agent.mdx#L13
[Google.Acronyms] Spell out 'LLM', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'LLM', if it's unfamiliar to the audience.", "location": {"path": "content/docs/agents/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 13, "column": 160}}}, "severity": "INFO"}
Check notice on line 13 in content/docs/agents/custom-code-agent/build-your-first-agent.mdx
github-actions / vale
[vale] content/docs/agents/custom-code-agent/build-your-first-agent.mdx#L13
[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "content/docs/agents/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 13, "column": 203}}}, "severity": "INFO"}
Check warning on line 13 in content/docs/agents/custom-code-agent/build-your-first-agent.mdx
github-actions / vale
[vale] content/docs/agents/custom-code-agent/build-your-first-agent.mdx#L13
[write-good.Passive] 'is done' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is done' may be passive voice. Use active voice if you can.", "location": {"path": "content/docs/agents/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 13, "column": 203}}}, "severity": "WARNING"}
Check notice on line 13 in content/docs/agents/custom-code-agent/build-your-first-agent.mdx
github-actions / vale
[vale] content/docs/agents/custom-code-agent/build-your-first-agent.mdx#L13
[Google.Passive] In general, use active voice instead of passive voice ('is done').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is done').", "location": {"path": "content/docs/agents/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 13, "column": 203}}}, "severity": "INFO"}
Check warning on line 15 in content/docs/agents/custom-code-agent/build-your-first-agent.mdx
github-actions / vale
[vale] content/docs/agents/custom-code-agent/build-your-first-agent.mdx#L15
[write-good.TooWordy] 'minimum' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'minimum' is too wordy.", "location": {"path": "content/docs/agents/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 15, "column": 40}}}, "severity": "WARNING"}
Check warning on line 31 in content/docs/agents/custom-code-agent/build-your-first-agent.mdx
github-actions / vale
[vale] content/docs/agents/custom-code-agent/build-your-first-agent.mdx#L31
[Novu.BulletStyle] Prefer '*' over '-' for bullet points (ignore inside code fences).
Raw output
{"message": "[Novu.BulletStyle] Prefer '*' over '-' for bullet points (ignore inside code fences).", "location": {"path": "content/docs/agents/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 31, "column": 1}}}, "severity": "WARNING"}
Check warning on line 32 in content/docs/agents/custom-code-agent/build-your-first-agent.mdx
github-actions / vale
[vale] content/docs/agents/custom-code-agent/build-your-first-agent.mdx#L32
[Novu.BulletStyle] Prefer '*' over '-' for bullet points (ignore inside code fences).
Raw output
{"message": "[Novu.BulletStyle] Prefer '*' over '-' for bullet points (ignore inside code fences).", "location": {"path": "content/docs/agents/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 32, "column": 1}}}, "severity": "WARNING"}
Check warning on line 33 in content/docs/agents/custom-code-agent/build-your-first-agent.mdx
github-actions / vale
[vale] content/docs/agents/custom-code-agent/build-your-first-agent.mdx#L33
[Novu.BulletStyle] Prefer '*' over '-' for bullet points (ignore inside code fences).
Raw output
{"message": "[Novu.BulletStyle] Prefer '*' over '-' for bullet points (ignore inside code fences).", "location": {"path": "content/docs/agents/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 33, "column": 1}}}, "severity": "WARNING"}
Check notice on line 48 in content/docs/agents/custom-code-agent/build-your-first-agent.mdx
github-actions / vale
[vale] content/docs/agents/custom-code-agent/build-your-first-agent.mdx#L48
[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "content/docs/agents/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 48, "column": 28}}}, "severity": "INFO"}
Check notice on line 55 in content/docs/agents/custom-code-agent/build-your-first-agent.mdx
github-actions / vale
[vale] content/docs/agents/custom-code-agent/build-your-first-agent.mdx#L55
[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "content/docs/agents/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 55, "column": 16}}}, "severity": "INFO"}
Check notice on line 95 in content/docs/agents/custom-code-agent/build-your-first-agent.mdx
github-actions / vale
[vale] content/docs/agents/custom-code-agent/build-your-first-agent.mdx#L95
[Google.Contractions] Use 'don't' instead of 'do not'.
Raw output
{"message": "[Google.Contractions] Use 'don't' instead of 'do not'.", "location": {"path": "content/docs/agents/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 95, "column": 90}}}, "severity": "INFO"}
Check notice on line 95 in content/docs/agents/custom-code-agent/build-your-first-agent.mdx
github-actions / vale
[vale] content/docs/agents/custom-code-agent/build-your-first-agent.mdx#L95
[Google.Semicolons] Use semicolons judiciously.
Raw output
{"message": "[Google.Semicolons] Use semicolons judiciously.", "location": {"path": "content/docs/agents/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 95, "column": 208}}}, "severity": "INFO"}
Check notice on line 101 in content/docs/agents/custom-code-agent/build-your-first-agent.mdx
github-actions / vale
[vale] content/docs/agents/custom-code-agent/build-your-first-agent.mdx#L101
[Google.Acronyms] Spell out 'LLM', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'LLM', if it's unfamiliar to the audience.", "location": {"path": "content/docs/agents/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 101, "column": 61}}}, "severity": "INFO"}
Check notice on line 258 in content/docs/agents/custom-code-agent/build-your-first-agent.mdx
github-actions / vale
[vale] content/docs/agents/custom-code-agent/build-your-first-agent.mdx#L258
[Google.Acronyms] Spell out 'LLM', if it's unfamiliar to the audience.
Raw output
{"message": "[Google.Acronyms] Spell out 'LLM', if it's unfamiliar to the audience.", "location": {"path": "content/docs/agents/custom-code-agent/build-your-first-agent.mdx", "range": {"start": {"line": 258, "column": 34}}}, "severity": "INFO"}