plan-on-md

Save planning outputs as Markdown files under project and branch paths.

1|2|Updated Jul 5, 2024
One-click install
npx skills add https://github.com/uuta/dotfiles --skill plan-on-md
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: plan-on-md
Source: https://github.com/uuta/dotfiles/tree/main/skills/plan-on-md
Command: npx skills add https://github.com/uuta/dotfiles --skill plan-on-md

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates saving planning outputs as local Markdown files, enabling seamless archival and retrieval of plans created in plan mode.

Core Features & Use Cases

  • Standardized file paths: saves plans to ~/uuta/Projects/{project_name}/{branch_name}/{file_name}.md with project names normalized by removing trailing numeric suffixes and branch names simplified to a concise numeric id.
  • Project-focused organization: keeps plans grouped by project and feature branch, making it easy to locate, review, and reference decisions.
  • Use Case: for example, planning a middleware refactor for project curry on branch feature/#468 results in ~/uuta/Projects/curry/468/middleware-refactor-plan.md.

Quick Start

Plan and save a new plan named 'middleware-refactor-plan' for project 'curry' on branch 'feature/#468' to the path ~/uuta/Projects/curry/468/middleware-refactor-plan.md.

Frequently Asked Questions about plan-on-md

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

FAQPage Schema
How do I save plan mode output as a local Markdown file?

To save plan mode output as a local Markdown file, the Skill automatically writes planning outputs to a structured path under ~/uuta/Projects/{project}/{branch}/{file}.md. It handles path derivation, file naming, and content preservation without requiring external tooling.

How are project and branch names formatted when saving Markdown plans?

When saving Markdown plans, project names are normalized by removing trailing numeric suffixes, and branch names are simplified to concise numeric identifiers. For example, branch 'feature/#468' becomes '468' in the file path.

Do I need any external tools or dependencies to save plans to Markdown?

No external tools or dependencies are required to save plans to Markdown. The Skill handles path derivation, file naming, and content preservation entirely on its own, satisfying local Markdown archival needs directly.

What is the best way to organize project plans by feature branches?

The best way to organize project plans by feature branches is using a standardized file path structure. This Skill groups plans under ~/uuta/Projects/{project_name}/{branch_name}/, keeping decisions easy to locate, review, and reference.

Can I use this Markdown plan saving workflow for any project?

Yes, you can use this Markdown plan saving workflow for any project-based workflow where plans are created in plan mode. It targets project-based workflows by normalizing project names and simplifying branch names for consistent local storage.

Why does my project name have numbers removed in the saved Markdown path?

Project names have trailing numeric suffixes removed in the saved Markdown path to normalize naming conventions. This ensures consistent directory structures, preventing duplicate or fragmented project folders caused by version numbers.