cleanup-docs

Archive doc/ to a timestamped _archive/ and generate a Steering-based README.md.

Updated Nov 6, 2025
One-click install
npx skills add https://github.com/a1hang/slack-issue-agent --skill cleanup-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cleanup-docs
Source: https://github.com/a1hang/slack-issue-agent/tree/main/.claude/skills/cleanup-docs
Command: npx skills add https://github.com/a1hang/slack-issue-agent --skill cleanup-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill reorganizes a project's documentation to OSS publication standards by archiving existing doc/ into a timestamped _archive/ location and generating a concise README.md based on Steering documents. This reduces manual cleanup time, preserves historical docs, and ensures external sharing uses clear, up-to-date information.

Core Features & Use Cases

  • Archive and preserve: Move doc/ into a timestamped archive folder to keep history intact.
  • Auto README generation: Create a concise, steering-based README.md for OSS publication.
  • Maintains discovery: Aligns with Steering docs: product, tech, structure to provide consistent documentation.
  • Use Case: Preparing a repo for OSS release or public sharing, run this Skill to produce a clean README and safe archive.

Quick Start

Use the cleanup-docs Skill to archive the existing doc/ directory into a timestamped _archive/ location and generate a new README.md based on Steering documents.

Frequently Asked Questions about cleanup-docs

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

FAQPage Schema
How do I archive my documentation directory and create a clean README for OSS publication?

Archive docs by moving your doc/ directory to a timestamped _archive/ location, then generate a concise README.md based on Steering documents. This Skill automates both steps, preserving historical documentation while preparing your repository for external sharing with clear, up-to-date information.

What information does the README extraction pull from Steering documents?

The Skill reads Steering documents to extract value propositions, core capabilities, architecture, and tech stack details. These elements populate the generated README.md, ensuring consistent documentation aligned with your project's steering definitions.

Can I use documentation cleanup to prepare a repository for open source release?

Yes. This Skill is designed for OSS publication workflows. It archives existing docs into timestamped folders, generates a steering-based README, and updates .gitignore to exclude archives, leaving your repository clean and ready for public release.

Does the cleanup process preserve my existing documentation?

Yes. Instead of deleting docs, the Skill moves your doc/ directory into a timestamped _archive/ folder. This keeps historical documentation intact while maintaining a clean repository structure for external sharing.

How does .gitignore get updated during documentation cleanup?

The Skill automatically updates .gitignore to exclude archive directories and maintain a clean repository state. This prevents timestamped _archive/ folders from being tracked, keeping your version control history focused on active documentation.

What's the best way to clean up documentation before sharing a repository externally?

Run documentation cleanup to archive old docs into timestamped folders and auto-generate a steering-based README. This approach reduces manual work, preserves history, and ensures your external-facing repository uses consistent, current documentation standards.