cleanup-docs

Community

Archive docs and publish OSS-ready READMEs.

Authora1hang
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: cleanup-docs
Download link: https://github.com/a1hang/slack-issue-agent/archive/main.zip#cleanup-docs

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository