Skip to content

Commit 7302b97

Browse files
authored
fix: update docs-sync instructions (#2336)
Update the `docs-sync.yml` workflow to encourage Claude to be more focused during docs creation. Currently Claude will make many small changes to documentation files, many of which are redundant, complicating code review. This PR encourages Claude to be more focused and succinct, simplifying review and making docs more maintainable.
1 parent 74ddfe2 commit 7302b97

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

.github/workflows/docs-sync.yml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,9 @@ jobs:
113113
- Only create documentation updates if they are actually needed
114114
- Don't document internal implementation details unless they affect usage
115115
- If no documentation updates are needed, simply state that and exit
116+
- Focus on adding documention to the 1-3 most relevant files, not everywhere
116117
- DO NOT create git branches, commits, or PRs - just update the files
118+
- DO NOT create many redundant code samples - create one sample and reference it as-needed
117119
118120
The docs repository is checked out in the `docs-repo` directory. Please analyze the controller changes and update the documentation files accordingly.
119121
@@ -132,28 +134,28 @@ jobs:
132134
# Create new branch
133135
BRANCH_NAME="docs-update-$(date +%s)"
134136
git checkout -b "$BRANCH_NAME"
135-
137+
136138
# Add and commit changes
137139
git add .
138140
if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
139141
git commit -m "docs: Update documentation for controller commit ${{ github.event.inputs.commit_sha }}
140142
141143
Updates documentation to reflect changes made in commit:
142144
${{ github.event.inputs.commit_sha }}
143-
145+
144146
Manually triggered documentation sync"
145147
else
146148
git commit -m "docs: Update documentation for controller PR #${{ github.event.pull_request.number }}
147149
148150
Updates documentation to reflect changes made in:
149151
${{ github.event.pull_request.title }}
150-
152+
151153
Related controller PR: cartridge-gg/controller#${{ github.event.pull_request.number }}"
152154
fi
153-
155+
154156
# Push branch
155157
git push origin "$BRANCH_NAME"
156-
158+
157159
# Create PR
158160
if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
159161
gh pr create \

0 commit comments

Comments
 (0)