Skip to content

Commit 8121c3f

Browse files
committed
fixed javadocs, godocs, github copolit, cursor and claude
1 parent ab01985 commit 8121c3f

File tree

9 files changed

+48
-31
lines changed

9 files changed

+48
-31
lines changed

docs/automations/integrations/javadoc/review-javadoc-input-parameters/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ description: Notify PR authors to ensure proper Javadoc coverage.
44
category: [docs, java]
55
---
66
# Review Java Input Parameters for Javadoc Changes
7+
<!-- --8<-- [start:example]-->
78

89
If a PR modifies the input parameters for a Java method, but not the associated Javadocs, notify reviewers to check for Javadoc updates.
910

@@ -35,3 +36,5 @@ If a PR modifies the input parameters for a Java method, but not the associated
3536
</span>
3637
</div>
3738
</div>
39+
40+
<!-- --8<-- [end:example]-->

docs/automations/integrations/javadoc/review-javadoc-large-change/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ description: Automatically flag large PRs that may require Javadoc updates.
44
category: [docs, java]
55
---
66
# Review Javadoc for Large Changes
7+
<!-- --8<-- [start:example]-->
78

89
Require more extensive reviews for large Java changes that lack Javadoc updates.
910

@@ -35,3 +36,4 @@ Require more extensive reviews for large Java changes that lack Javadoc updates.
3536
</span>
3637
</div>
3738
</div>
39+
<!-- --8<-- [end:example]-->

docs/automations/integrations/javadoc/review-javadoc/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ description: Automatically approve PRs that only contain Javadoc changes.
44
category: [docs, java]
55
---
66
# Review Javadoc Changes
7+
<!-- --8<-- [start:example]-->
78

89
Unblock PRs that only change Javadoc content.
910

@@ -36,3 +37,4 @@ Unblock PRs that only change Javadoc content.
3637
</span>
3738
</div>
3839
</div>
40+
<!-- --8<-- [end:example]-->

docs/automations/integrations/javadoc/review-new-class-javadoc/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ description: Automatically request changes for PRs that fail to meet Javadoc req
44
category: [docs, java]
55
---
66
# Enforce Javadoc Requirements for New Classes
7+
<!-- --8<-- [start:example]-->
78

89
Automatically request changes when someone creates a new Java class that lacks Javadoc content.
910

@@ -34,3 +35,4 @@ Automatically request changes when someone creates a new Java class that lacks J
3435
</span>
3536
</div>
3637
</div>
38+
<!-- --8<-- [end:example]-->

docs/integrations/claude-code.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@ description: Workflow automations to improve your Claude Code AI usage.
44
---
55
# Integrate gitStream with Claude Code
66

7-
## Automatically Label Claude Code-Assisted PRs
7+
## Automation Examples
8+
9+
### Automatically Label Claude Code-Assisted PRs
810

911
--8<-- "docs/automations/integrations/claude-code/flag-claude-code-pr/README.md:example"
1012

1113
## Additional Resources
1214

1315
--8<-- "docs/snippets/general.md"
1416

15-
--8<-- "docs/snippets/automation-footer.md"
17+
--8<-- "docs/snippets/automation-footer.md"

docs/integrations/cursor.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@ description: Workflow automations to improve your Cursor AI usage.
44
---
55
# Integrate gitStream with Cursor
66

7-
## Automatically Label Cursor-Assisted PRs
7+
## Automation Examples
8+
9+
### Automatically Label Cursor-Assisted PRs
810

911
--8<-- "docs/automations/integrations/cursor/flag-cursor-pr/README.md:example"
1012

1113
## Additional Resources
1214

1315
--8<-- "docs/snippets/general.md"
1416

15-
--8<-- "docs/snippets/automation-footer.md"
17+
--8<-- "docs/snippets/automation-footer.md"

docs/integrations/github-copilot.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,14 @@ description: Workflow automations to improve your GitHub Copilot usage.
44
---
55
# Integrate gitStream with GitHub Copilot
66

7+
## Automation Examples
78

8-
## Automatically Label Copilot-Assisted PRs
9+
### Automatically Label Copilot-Assisted PRs
910

1011
--8<-- "docs/automations/integrations/copilot/flag-copilot-pr/README.md:example"
1112

12-
1313
## Additional Resources
1414

1515
--8<-- "docs/snippets/general.md"
1616

17-
--8<-- "docs/snippets/automation-footer.md"
18-
17+
--8<-- "docs/snippets/automation-footer.md"

docs/integrations/godoc.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,18 @@ description: Workflow automations for Godoc code reviews.
44
---
55
# Integrate gitStream with Godoc
66

7-
## Review Godoc Changes
7+
## Automation Examples
8+
9+
### Review Godoc Changes
10+
811
--8<-- "docs/automations/integrations/godoc/review-godoc/README.md:example"
912

10-
## Enforce Godoc Requirements for New Classes
13+
### Enforce Godoc Requirements for New Classes
14+
1115
--8<-- "docs/automations/integrations/godoc/review-godoc-new-class/README.md:example"
1216

13-
## Review Godoc for Large changes
17+
### Review Godoc for Large changes
18+
1419
--8<-- "docs/automations/integrations/godoc/review-godoc-large/README.md:example"
1520

1621
## Additional Resources
@@ -19,5 +24,4 @@ description: Workflow automations for Godoc code reviews.
1924

2025
--8<-- "docs/snippets/automation-footer.md"
2126

22-
23-
Special thanks to [Boemo W Mmopelwa](https://github.com/xTrilton) for providing these examples.
27+
Special thanks to [Boemo W Mmopelwa](https://github.com/xTrilton) for providing these examples.

docs/integrations/javadoc.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,28 @@ description: Implement workflow automations for Javadoc code reviews.
44
---
55
# Integrate gitStream with Javadoc
66

7-
Javadoc Examples:
7+
## Automation Examples
88

9-
* [Review Javadoc Changes](#review-javadoc)
10-
* [Review Java Input Parameters for Javadoc Changes](#review-javadoc-input-parameters)
11-
* [Review Javadoc for Large Changes](#review-javadoc-large-change)
12-
* [Enforce Javadoc Requirements for New Classes](#review-new-class-javadoc)
9+
### Review Javadoc Changes
1310

14-
<a name="review-javadoc"></a>
15-
## Review Javadoc Changes
16-
--8<-- "docs/automations/integrations/javadoc/review-javadoc/README.md:6:"
11+
--8<-- "docs/automations/integrations/javadoc/review-javadoc/README.md:example"
1712

18-
<a name="review-javadoc-input-parameters"></a>
19-
## Review Java Input Parameters for Javadoc Changes
20-
--8<-- "docs/automations/integrations/javadoc/review-javadoc-input-parameters/README.md:6:"
13+
### Review Java Input Parameters for Javadoc Changes
2114

22-
<a name="review-javadoc-large-change"></a>
23-
## Review Javadoc for Large Changes
24-
--8<-- "docs/automations/integrations/javadoc/review-javadoc-large-change/README.md:6:"
15+
--8<-- "docs/automations/integrations/javadoc/review-javadoc-input-parameters/README.md:example"
2516

26-
<a name="review-new-class-javadoc"></a>
27-
## Enforce Javadoc Requirements for New Classes
28-
--8<-- "docs/automations/integrations/javadoc/review-new-class-javadoc/README.md:6:"
17+
### Review Javadoc for Large Changes
2918

30-
Special thanks to [Boemo W Mmopelwa](https://github.com/xTrilton) for providing these examples.
19+
--8<-- "docs/automations/integrations/javadoc/review-javadoc-large-change/README.md:example"
20+
21+
### Enforce Javadoc Requirements for New Classes
22+
23+
--8<-- "docs/automations/integrations/javadoc/review-new-class-javadoc/README.md:example"
24+
25+
## Additional Resources
26+
27+
--8<-- "docs/snippets/general.md"
28+
29+
--8<-- "docs/snippets/automation-footer.md"
30+
31+
Special thanks to [Boemo W Mmopelwa](https://github.com/xTrilton) for providing these examples.

0 commit comments

Comments
 (0)