repo-polish

Generate metadata files and scaffold documentation for software repository releases.

2|1|Updated Feb 18, 2026

Search Tags:#documentation #github #audit #repository #release #metadata

Ready to run

npx skills add https://github.com/queelius/claude-anvil --skill repo-polish

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: repo-polish
Source: https://github.com/queelius/claude-anvil/tree/main/repoindex/skills/repo-polish
Command: npx skills add https://github.com/queelius/claude-anvil --skill repo-polish

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill streamlines the process of preparing a software repository for public release by automating metadata completion, documentation setup, and quality auditing.

Core Features & Use Cases

Metadata Generation: Creates essential files like CITATION.cff, .zenodo.json, codemeta.json, LICENSE, .gitignore, CODE_OF_CONDUCT.md, and CONTRIBUTING.md.
Documentation Scaffolding: Sets up mkdocs for documentation sites and GitHub Actions for deployment.
GitHub Enhancement: Manages repository topics and descriptions based on pyproject.toml.
Audit & Improvement: Audits repository completeness and assists in writing/improving READMEs and documentation content.

Quick Start

Use the repo-polish skill to prepare the current repository for release.

Frequently Asked Questions about repo-polish

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

FAQPage Schema

How do I prepare a software repository for public release?▼

Preparing a repository for release involves generating metadata files like CITATION.cff and LICENSE, scaffolding mkdocs documentation, and auditing public-facing quality. This Skill automates that workflow by orchestrating the repoindex CLI for deterministic tasks and leveraging AI for prose improvements.

How do I generate CITATION.cff and codemeta.json metadata files automatically?▼

To generate metadata files like CITATION.cff, .zenodo.json, and codemeta.json automatically, use an automation tool that reads project configuration. This Skill creates these essential files by reading pyproject.toml and orchestrating the repoindex CLI to ensure accurate repository metadata.

How do I set up mkdocs documentation with GitHub Actions deployment?▼

Setting up mkdocs documentation with GitHub Actions deployment requires scaffolding the site structure and configuring workflow files. This Skill automates documentation scaffolding by setting up mkdocs and managing the necessary GitHub Actions configurations for automated deployment.

Can I batch audit multiple GitHub repositories for release readiness?▼

Yes, you can batch audit multiple GitHub repositories for release readiness. This Skill is applicable to individual repositories or batch operations across collections, auditing repository completeness and generating consistent metadata files across all selected projects.

Do I need repoindex to generate repository metadata and documentation?▼

Yes, repoindex is required to generate repository metadata and documentation. This Skill orchestrates the repoindex CLI to handle deterministic tasks like metadata generation and documentation scaffolding, while leveraging AI separately for context-dependent prose and README improvements.

How do I update GitHub repository topics and descriptions from pyproject.toml?▼

Updating GitHub repository topics and descriptions from pyproject.toml involves parsing the configuration file and applying the changes via the GitHub API. This Skill manages GitHub enhancement by automatically extracting data from pyproject.toml to update repository topics and descriptions.