Skip to content

Commit 6e77148

Browse files
authored
Merge pull request #644 from linear-b/fix-askai-summarize
update document readme
2 parents 4649afe + 9237bf6 commit 6e77148

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

docs/automations/integrations/askAI/document/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
2-
title: Automation - Ask AI to Summarize the Changes in a PR
3-
description: Use gitStream's integration with AI services to generate a summary of the changes in the PR.
2+
title: Automation - Ask AI to provide PR documentation
3+
description: Use gitStream's integration with AI services to generate conscious documentation of the changes in the PR.
44
category: [quality, genai, copilot, tests, efficiency]
55
---
6-
# Ask AI to Summarize the Changes in a PR
6+
# Ask AI to provide PR documentation
77

88
<!-- --8<-- [start:example]-->
9-
Use AI to generate a documentation for the newly added features and changes based on the code diff.
9+
Use AI to generate documentation for the newly added features and changes based on the code diff.
1010

1111
!!! info "Configuration Description"
1212

1313
Conditions (all must be true):
1414

15-
* A PR is created or new code has been committed to the PR.
15+
* A PR is created, or new code has been committed to the PR.
1616
* The PR has a label "askai document"
1717

1818
Automation Actions:

docs/automations/integrations/askAI/improve/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
---
2-
title: Automation - Ask AI to Summarize the Changes in a PR
3-
description: Use gitStream's integration with AI services to generate a summary of the changes in the PR.
2+
title: Automation - Ask AI for code suggestions to improve the PR
3+
description: Use gitStream's integration with AI services to generate code suggestions to improve the PR.
44
category: [quality, genai, copilot, tests, efficiency]
55
---
6-
# Ask AI to provide code suggestion to improve the PR
6+
# Ask AI to provide code suggestions to improve the PR
77

88
<!-- --8<-- [start:example]-->
9-
Use AI to generate improvement suggestions for the code changes.
9+
Use AI to generate suggestions for improvement in the code changes.
1010

1111
!!! info "Configuration Description"
1212

1313
Conditions (all must be true):
1414

15-
* A PR is created or new code has been committed to the PR.
15+
* A PR is created, or a new code has been committed to the PR.
1616
* The PR has a label "askai improve"
1717

1818
Automation Actions:
1919

20-
* Add a comment with omprovement suggestions for the added code
20+
* Add a comment with improvement suggestions for the added code
2121

2222
!!! example "Configuration Example"
2323
```yaml+jinja

0 commit comments

Comments
 (0)