Skip to content

README.md

Latest commit

 

History

History
36 lines (24 loc) · 1.38 KB

README.md

File metadata and controls

36 lines (24 loc) · 1.38 KB
Raw

Prompts Release Docs for Pi

Adds ready-made prompts for release notes, announcements, README updates, and wiki updates.

What you can do

  • Creates release notes and announcements.
  • Updates README and wiki content from real changes.
  • Summarizes branches and versions for publication.
  • Keeps generated release material in predictable project folders.

Install

Install it through Pi:

pi install npm:@firstpick/pi-prompts-release-docs

Restart Pi if the package does not appear in your current session.

How to use it

Choose the prompt for the document you need, such as /announce-version or /readme-update, and point Pi at the real changes or release information.

  • /announce-branch — create a short user-facing branch announcement.
  • /announce-version — create a short user-facing version announcement.
  • /readme-update — update README content from actual branch changes.
  • /release-new — generate release notes for a version.
  • /ship — prepare verification notes, release notes, commits, and risks.
  • /summary — summarize recent repository work.
  • /update-wiki — update wiki docs from branch changes.

Technical details

See TECHNICAL.md for complete commands, configuration, compatibility, security, and troubleshooting information.