release-docs

Name: release-docs
Availability: InStock
Author: tubtrb

Align repository public docs and metadata with the current autoreport implementation.

Updated Mar 15, 2026

Search Tags:#documentation #publishing #metadata #docs #release-notes #autoreport

Ready to run

npx skills add https://github.com/tubtrb/autoreport --skill release-docs-tubtrb

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: release-docs
Source: https://github.com/tubtrb/autoreport/tree/main/codex/skills/release-docs
Command: npx skills add https://github.com/tubtrb/autoreport --skill release-docs-tubtrb

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Public-facing project docs, metadata, and release wording often drift from the current autoreport implementation. This skill keeps README, pyproject.toml, release notes, and repo-tracked words aligned with the codebase and tests.

Core Features & Use Cases

Aligns README, pyproject.toml, and examples to the latest autoreport behavior.
Coordinates with related skills like write-doc-markdown and autorelease-handoff to ensure consistent public messaging.
Ensures versioned surfaces and public wording reflect the live code/tests.

Quick Start

Align public-facing repo docs and metadata with the current autoreport implementation.

Frequently Asked Questions about release-docs

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

FAQPage Schema

How do I keep public repository docs and metadata in sync with code?▼

To keep public docs and metadata in sync with code, cross-check the codebase and tests against READMEs, pyproject.toml, and release notes to enforce alignment with the current implementation.

What is the best way to align release notes with the latest codebase behavior?▼

Aligning release notes with codebase behavior requires cross-checking tests and references/public-surfaces.md to ensure versioned surfaces and public wording reflect the live code.

Why does my pyproject.toml metadata drift from the current implementation?▼

Project metadata in pyproject.toml drifts when public-facing docs are not cross-checked against the codebase and tests, requiring alignment enforcement to match the live autoreport implementation.

How to update README and public-facing docs before a release?▼

Updating READMEs and public-facing docs before a release involves cross-checking related skills and references/public-surfaces.md to guide documentation updates and ensure consistent public messaging.

Can I use automated documentation alignment for pyproject.toml and release notes?▼

Automated documentation alignment for pyproject.toml and release notes is possible by enforcing cross-checks between code, tests, and tracked public surfaces to maintain versioned consistency.

How do coordinated skills ensure consistent public messaging during a release?▼

Coordinated skills ensure consistent public messaging by aligning READMEs, metadata, and release notes with the live codebase and tests to guide documentation updates across the project.