You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I need you to analyze the changes in this controller repository PR and determine if the documentation in the cartridge-gg/docs repository needs to be updated.
79
+
I need you to analyze the changes in this controller repository PR and update the documentation in the cartridge-gg/docs repository accordingly.
80
80
81
81
**PR Information:**
82
82
- Title: ${{ github.event.pull_request.title }}
@@ -88,25 +88,65 @@ jobs:
88
88
2. Check the docs-repo directory to see what documentation currently exists
89
89
3. Determine if any existing documentation needs updates or if new documentation should be created
90
90
4. If updates are needed:
91
-
- Create or update the appropriate documentation files
91
+
- Create or update the appropriate documentation files in the docs-repo directory
92
92
- Ensure the documentation accurately reflects the current state of the controller
93
93
- Follow the existing documentation style and structure
94
-
- Create a new branch in the docs repo
95
-
- Commit the changes with a descriptive message
96
-
- Create a pull request in the docs repository
94
+
- Focus on user-facing changes, API changes, new features, or breaking changes
97
95
98
96
**Important guidelines:**
99
97
- Only create documentation updates if they are actually needed
100
-
- Focus on user-facing changes, API changes, new features, or breaking changes
101
98
- Don't document internal implementation details unless they affect usage
102
99
- If no documentation updates are needed, simply state that and exit
100
+
- DO NOT create git branches, commits, or PRs - just update the files
101
+
102
+
The docs repository is checked out in the `docs-repo` directory. Please analyze the controller changes and update the documentation files accordingly.
0 commit comments