Add docgen-fixup skill#208
Open
ernestognw wants to merge 2 commits into
Open
Conversation
Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
✅ Deploy Preview for openzeppelin-docs-v2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
… pattern Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
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.
Summary
skills/docgen-fixup/that catalogs the known regression patterns the docgen pipeline introduces on each auto-generated API docs PR (the ones opened by.github/workflows/generate-api-docs-*.yml), detects them on a specific PR, and applies direct MDX patches — while also flagging NatSpec /.adocmistakes that should be fixed upstream in the source contracts repo.references/patterns.mdas they emerge.{Type}xref leaks, cross-contract method mis-linking, dangling struct/enum/UDVT anchors, trailing===in headings, orphaned[TIP]====blocks, and broken external → internal URL rewrites. Each entry has symptom / detection / root cause / upstream fix / MDX patch / example.Files
skills/docgen-fixup/SKILL.md— trigger, inputs, workflow overview.skills/docgen-fixup/process.md— step-by-step workflow.skills/docgen-fixup/references/patterns.md— the pattern catalog. Living document.skills/docgen-fixup/references/report-template.md— final-report shape.Test plan
mainafter PR [CI] Update API docs for OpenZeppelin/openzeppelin-contracts v5.7.0-rc.0 #206 lands.🤖 Generated with Claude Code