docs: initialize v0.8 to v1.0 migration guide skeleton#123
Draft
tablackburn wants to merge 1 commit into
Draft
Conversation
Phase 1 of #120. Creates docs/migration-v0.8-to-v1.0.md (matching the psake/psake docs/migration-v4-to-v5.md convention) with: - Scope blurb and Quick Start placeholder - AI-assisted migration prompt (referential style for IDE/CLI agents) - One labeled illustrative entry showing the loose format - "Adding an entry" spec for future breaking-change PRs Adds a one-line CHANGELOG entry under Unreleased. No code or dependency changes. Path diverges from #120's original spec (docs/migration/v0.8-to-v1.0.md) to match the org-level convention established by psake/psake. #120's body has been updated to reference the new flat path. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Phase 1 of #120. Initializes
docs/migration-v0.8-to-v1.0.mdso Phase 2+ breaking PRs have a defined home for migration entries and the v1.0.0 deliverable AI-assisted migration prompt has a stable, versioned location.What's included
docs/migration-v0.8-to-v1.0.md(new) — empty skeleton with:CHANGELOG.md)# MIGRATION-REVIEW:comments.psake/psake docs/migration-v4-to-v5.md: heading + prose +Before/Aftercode blocks, with the rigid 5-field template downgraded to suggested subsections.CHANGELOG.md— one-line entry under## Unreleased/### Added.Org convention alignment
Path diverges from #120's original spec:
docs/migration/v0.8-to-v1.0.md(nested in amigration/subdirectory)docs/migration-v0.8-to-v1.0.md(flat)Reason:
psake/psakealready ships a sibling-pattern migration guide atdocs/migration-v4-to-v5.md. Matching the org convention reduces cross-repo friction. #120's body has been updated to reference the new path.Scope
Docs-only — no code, dependency, or workflow changes. The illustrative entry is fictional and gets deleted by the first real Phase 2 PR.
Not in this PR
instructions/git-workflow.instructions.md— left alone (upstream AIM template). The "Adding an entry" spec for PR authors lives inside the migration file itself.Test plan
psake/psakeconvention🤖 Generated with Claude Code