Skip to content

Improve upstream-release-docs skill with verification lessons#686

Merged
rdimitrov merged 1 commit intomainfrom
improve-upstream-release-skill
Apr 10, 2026
Merged

Improve upstream-release-docs skill with verification lessons#686
rdimitrov merged 1 commit intomainfrom
improve-upstream-release-skill

Conversation

@rdimitrov
Copy link
Copy Markdown
Member

Summary

Improves the upstream-release-docs skill based on lessons learned during the Registry Server v1.0.0/v1.0.1 documentation update (#683).

Changes

  • Check related repositories (Phase 2, step 5): Components often span multiple repos — an operator/CRD may live in a different repo than the server. The skill now prompts checking related repos for coordinated changes.
  • Deep-verify behavioral claims (Phase 2, step 8): New checklist for the most common sources of documentation inaccuracy — API route registration, required field validation logic, default value fallbacks, precedence chains, delete/cleanup behavior, query parameter wiring, and authorization containment direction.
  • Parallel verification agents (Phase 5, step 1): For large doc sets, spawn parallel agents (one per file) to verify all factual claims concurrently against source code.

Motivation

During the Registry Server docs update, we found 9 accuracy bugs that survived multiple editorial review rounds but were caught by source code verification agents:

Bug Root cause
Wrong publish/delete API URLs Route handlers weren't checked — only handler names
description listed as required Struct field existed but validation didn't check it
status filter documented but non-functional Query param parsed but never wired to service layer
Delete latest pointer behavior inverted Docs assumed behavior without checking delete logic
Git ref precedence wrong (tag > branch) if/else chain was branch > tag in actual code
Git branch "defaults to main" Actually defaults to remote's HEAD branch
format incorrectly marked required Validation allowed empty value
Publish subset example inverted Containment direction was caller/resource, not resource/caller
/openapi.json missing from public paths Code had 5 default paths, docs listed 4

All of these would have been caught earlier with the behavioral verification checklist now added to the skill.

Test plan

  • Skill file passes Prettier formatting
  • Pre-commit hooks pass

🤖 Generated with Claude Code

Add three improvements based on lessons learned during the Registry
Server v1.0.0/v1.0.1 docs update:

- Check related repositories (operators, CLIs) for coordinated changes
- Deep-verify behavioral claims (API routes, required fields, defaults,
  precedence rules, delete behavior, query param wiring, auth direction)
- Spawn parallel verification agents for large doc sets

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 9, 2026 22:49
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 9, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-website Ready Ready Preview, Comment Apr 9, 2026 10:50pm

Request Review

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the .claude/skills/upstream-release-docs skill to reduce documentation accuracy bugs by expanding the verification workflow used when documenting upstream releases.

Changes:

  • Add an explicit “check related repositories” step to catch coordinated multi-repo changes (e.g., operator/CRD vs server).
  • Add a behavioral verification checklist to validate runtime behavior (routes, validation, defaults, precedence, deletes, query params, auth containment direction), not just structs/types.
  • Extend final validation guidance to optionally use parallel verification agents for large doc sets.

@rdimitrov rdimitrov merged commit e3c9a2f into main Apr 10, 2026
8 checks passed
@rdimitrov rdimitrov deleted the improve-upstream-release-skill branch April 10, 2026 05:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants