[DOCS] Add a skill for the spec sync and regeneration pipeline - #28
Merged
Merged
Conversation
Nothing notifies this repo when the backend's spec moves, and the upgrade that follows is ordered: copy the spec, move SPEC_SOURCE with it, regenerate, review the generated surface with `git add -N` so new files count, then expose anything new through the facade. That sequence lived only in the heads of the people who built it. Records it as a repo-local skill, pointing at the existing scripts and gates rather than restating them, and pins the two rules a newcomer gets wrong: the generated tree is never hand-edited, and __version__ is the last released version that the release workflow bumps at dispatch, not something a PR moves. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CSm32dsxD56PkKENgav3Mn
Contributor
|
| Filename | Overview |
|---|---|
| .claude/skills/spec-upgrade/SKILL.md | Documents the complete spec-upgrade pipeline; the latest changes fully address both previous review findings. |
Reviews (2): Last reviewed commit: "docs: show the full generated diff, and ..." | Re-trigger Greptile
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CSm32dsxD56PkKENgav3Mn
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
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.
What
Adds
.claude/skills/spec-upgrade/SKILL.md— the ordered sequence for picking up a new backend spec, for a future maintainer or agent with no prior context.Nothing notifies this repo when
specs/docstudio-oss.jsonmoves in the backend, and the upgrade that follows is ordered:SPEC_SOURCEintools/gen_sdk.shin the same commit — without it, a stale copy and a current one both report clean./tools/gen_sdk.shgit add -Nfirst, so a newly generated file countsclient.py, never the generated treepytest, leaving thetests/baseline/parity reference where it isPlus the two rules a newcomer gets wrong: the generated tree is never hand-edited, and
__version__is the last released version thatmain.ymlbumps at dispatch — not something a PR moves.Why
The pipeline is real and undocumented in-repo. It points at the existing scripts and gates rather than restating them, and carries no version numbers, dates or codenames, so it should not go stale.
Notes
Docs only — no code, no CI changes.
🤖 Generated with Claude Code
https://claude.ai/code/session_01CSm32dsxD56PkKENgav3Mn