skills.rest
mishrasanjeev
mishrasanjeevCOMMUNITY
Explore all skills by this author →
𝕏@mishrak_sanjeevGitHub

ship-verification

Analyze code diffs to validate documentation alignment with deployed code.

31|7|Updated Feb 25, 2026
Search Tags:#documentation consistency#release process#release verification#post-merge check#docs validation
One-click install
npx skills add https://github.com/mishrasanjeev/grantex --skill ship-verification
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: ship-verification
Source: https://github.com/mishrasanjeev/grantex/tree/main/skills/ship-verification
Command: npx skills add https://github.com/mishrasanjeev/grantex --skill ship-verification

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines post-merge verification to prevent discrepancies between deployed code and public documentation, reducing release errors and user confusion.

Core Features & Use Cases

  • Diff analysis: Identifies which code changes, documentation updates, or asset modifications occurred in a release.
  • Scope assessment: Checks whether any user-facing surfaces, such as APIs or SDKs, have changed.
  • Alignment validation: Confirms that README, SDK docs, and landing pages accurately reflect the current release state.
  • Use Case: After merging a feature branch, run this Skill to verify all relevant docs and surfaces are up to date with the latest code changes before public release.

Quick Start

Run this Skill after merging a pull request to ensure that your documentation and public-facing surfaces accurately reflect the shipped code.

Frequently Asked Questions about ship-verification

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I verify documentation consistency after merging code changes?▼

Documentation consistency after merging is verified by analyzing code diffs against README files, SDK docs, and landing pages. This process checks for discrepancies between deployed code and public surfaces to prevent user-facing drift before release.

What is the best way to prevent user-facing drift during a release cycle?▼

Preventing user-facing drift during a release cycle requires post-merge checks that analyze code diffs and validate public surfaces. Scope assessment identifies whether APIs or SDKs changed, ensuring alignment between recent updates and public documentation.

How do I validate that my release notes match the shipped code?▼

Release notes validation confirms alignment between shipped code and documentation by analyzing code diffs, README files, and landing pages. This post-merge check ensures public surfaces accurately reflect current release contents and prevents release errors.

Can I check if my SDK docs reflect recent code updates before a public release?▼

Checking if SDK docs reflect recent code updates involves alignment validation across development workflows. By analyzing code diffs and comparing them against SDK documentation and landing pages, discrepancies are identified to ensure public surfaces match the deployed state.

When do I need to run documentation validation in my release process?▼

Documentation validation is needed during release cycles and post-merge stages. After merging a pull request, running this check verifies that all relevant documentation and public-facing surfaces accurately reflect the shipped code changes before public release.

Why does my public documentation show discrepancies after a feature branch merge?▼

Discrepancies after a feature branch merge occur when code diffs are not validated against public surfaces. Without post-merge checks, README files, SDK docs, and landing pages fail to align with recent updates, causing user confusion and release errors.

Related Skills

Explore More Content & Communication Skills→
jackspacejackspace
16

open-source-contributions

Prepare pull requests with pre-submission checks and templates.

Community
Advanced
haojing8312haojing8312
154

workclaw-release-publish

Publish a confirmed WorkClaw release with git tag and Windows installer.

Community
Advanced
yocxy2yocxy2

land-and-deploy

Merge pull requests and verify production deployment health with canary checks.

Community
Advanced
Lev-itLev-it

intended-vs-implemented

Audit discrepancies between documented system intent and code implementation.

Official
Advanced