Add the imgproxy-docs-sync skill - #92
Open
11bit wants to merge 2 commits into
Open
Conversation
The imgproxy-docs repo dispatches to this one whenever the Usage section of the documentation changes, and the workflow opens an issue linking to a compare range. Working through one of those issues is the same set of steps every time: read the diff, decide which hunks are actually URL options we emit, map them onto this repo's layout, then implement. This skill encodes that. It resolves the issue, pulls the docs diff filtered to docs/usage/**, classifies each hunk (new option / changed option / removed / prose only / out of scope), prints a plan with the URL strings the change would emit, and only implements it after approval, finishing with a changeset and a PR that closes the issue. The reference file captures the conventions that are easy to get wrong: the four alphabetical wiring edits, the Options intersection in src/types/index.ts, the guard table with its exact error strings, and the optional-positional-argument rules from the gradient fix. .claude/settings.local.json is gitignored so the skill can be tracked without dragging local permissions along with it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UoYDgwBavVrxfoRrXn4ZHb
The skill was committed without any entry point for someone who doesn't already know it exists. Adds a "Syncing with imgproxy docs" section: how the dispatch/issue chain works, the one-time setup, the literal command to type, and what the approval gate asks. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Gvc3eYgQS7juqk4LnaUG4J
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a Claude Code skill at
.claude/skills/imgproxy-docs-sync/for working through the auto-generated "Usage docs of imgproxy have been updated" issues.Those issues all have the same shape — a link to an
imgproxy-docscompare range — and turning one into a PR is the same set of steps every time. The skill encodes them:<base>...<head>shas.gh api, filtered todocs/usage/**;docs/configuration/**and friends are reported as ignored rather than dropped silently. Cross-check each option against the rendered docs page, since a hunk alone doesn't carry defaults or ranges.lint && check-types && test && build, write a changeset by hand, and open a PR withCloses #N.references/repo-conventions.mdholds the things that are easy to get wrong here:src/options/index.tsorder is the URL segment order at runtimeOptionsintersection insrc/types/index.ts— builds fine, type-errors for consumersgradientfix: gate on!== undefined, default with??, trim trailing colons once at the end((pro))→**PRO feature**JSDoc, andnpm run test -- --runrather than watch modeAlso gitignores
.claude/settings.local.json, so the skill can be tracked without local permission settings tagging along.Using it
Then, at the Claude Code prompt:
82is the auto-generated issue's number; an issue URL works too, and/imgproxy-docs-syncwith noargument lists the open ones and asks which. It runs unattended until it prints the plan, then asks
one question — Proceed as planned / Proceed with changes / Report only / Cancel. Nothing is
written to disk before that answer, and it never merges the PR it opens.
README.md gained a "Syncing with imgproxy docs" section covering this, plus the dispatch → issue
chain that produces the issues in the first place.
Only the README and the skill files are touched; no production code changes.
🤖 Generated with Claude Code
https://claude.ai/code/session_01UoYDgwBavVrxfoRrXn4ZHb