project-migrate

Migrate existing project documentation to the SynthesisFlow directory structure with AI-assisted categorization.

Updated Jul 13, 2024
One-click install
npx skills add https://github.com/Reading-Advantage-Thailand/codecamp-advantage --skill project-migrate-reading-advantage-thailand
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: project-migrate
Source: https://github.com/Reading-Advantage-Thailand/codecamp-advantage/tree/main/.claude/skills/project-migrate
Command: npx skills add https://github.com/Reading-Advantage-Thailand/codecamp-advantage --skill project-migrate-reading-advantage-thailand

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve? Moving an existing project's documentation into a structured convention like SynthesisFlow is error-prone: files get miscategorized, relative links break, git history is lost, and there is no safe way to undo mistakes. This Skill automates the entire brownfield migration with backups, validation, and rollback support. ## Core Features & Use Cases - AI-Powered Discovery and Categorization: Uses the Gemini CLI to analyze document content and classify files as specs, proposals, ADRs, designs, plans, or general docs, then maps them to docs/specs/, docs/changes/, or docs/. - Safe Migration Workflow: Creates a timestamped backup with a rollback script, moves files with git mv to preserve history, and detects target conflicts before any changes are made. - LLM-Based Link Correction and Frontmatter Generation: Fixes broken relative links after moves and generates doc-indexer compliant YAML frontmatter for files that lack it. - Use Case: You inherit a repository with markdown scattered across docs/, wiki/, and the root. Run the script in dry-run mode to review the AI-generated migration plan, approve it, and get a fully reorganized SynthesisFlow structure with a rollback option. ## Quick Start Run the project-migrate script in dry-run mode to preview how my existing markdown documentation would be reorganized into the SynthesisFlow structure.

Frequently Asked Questions about project-migrate

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

FAQPage Schema
How do I migrate existing documentation to the SynthesisFlow structure?▼

Run the project-migrate.sh script in interactive, dry-run, or auto-approve mode. It discovers markdown files, uses the Gemini CLI to categorize them by content, presents a migration plan for approval, then moves files with git mv while creating a backup and rollback script.

How does the migration categorize markdown files?▼

The Gemini CLI analyzes each file's content and classifies it as spec, proposal, adr, design, plan, retrospective, or doc. Specs, ADRs, designs, and plans go to docs/specs/, proposals go to docs/changes/, and general docs go to docs/.

Can I preview the migration plan before making changes?▼

Yes, run the script with the --dry-run flag to generate the complete migration plan and a JSON manifest without moving any files. You can also save the plan and exit, then re-run the migration later.

Does the migration preserve git history for moved files?▼

Yes, the script uses git mv to relocate files, which preserves their commit history. It also creates a timestamped backup of the docs/ directory with a rollback.sh script before making any changes.

What happens if the Gemini CLI is not installed or fails?▼

The script falls back to default categorization (treating files as general docs) when Gemini returns invalid output or is unavailable. For best results, install the gemini CLI, authenticate with gemini auth, and verify network connectivity.

How are broken relative links fixed after files are moved?▼

A Python script sends each migrated file's content to the Gemini CLI, which identifies and corrects broken relative links based on the file's new location. External URLs, anchors, and email links are left unchanged.