Skip to content

feat(guides): generate npm migration and best-practice artifacts - #82

Draft
harlan-zw wants to merge 5 commits into
mainfrom
feat/npm-guides
Draft

feat(guides): generate npm migration and best-practice artifacts#82
harlan-zw wants to merge 5 commits into
mainfrom
feat/npm-guides

Conversation

@harlan-zw

Copy link
Copy Markdown
Collaborator

🔗 Linked issue

None.

❓ Type of change

  • 📖 Documentation
  • 🐞 Bug fix
  • 👌 Enhancement
  • ✨ New feature
  • 🧹 Chore
  • ⚠️ Breaking change

📚 Description

Adds a local pipeline that turns npm release notes into version-scoped migration runbooks and package documentation into best-practice skills. Deterministic bucketing handles structured changelogs; an LLM handles formats the parser cannot classify. Pipeline stamps and content hashes make batch regeneration incremental.

✅ Validation

  • pnpm lint
  • pnpm typecheck
  • pnpm build
  • Unit suite: 860 passed

The full suite currently has eight unrelated live-resolution failures involving React, motion-v, and the prompt fixture.

harlan-zw added 5 commits May 31, 2026 17:49
…ntal pipeline

- semverMajor + scope guides to one major (v3→v4 window); previousMajorAnchor for 'from'.
- Per-version buckets (VersionBuckets) surfaced for the site's from-version selector.
- Detect [**BREAKING**]/**BREAKING** markers (jest/babel monorepo changelogs).
- version.ts stamps (BUCKET_RULES/RUNBOOK_PROMPT/PIPELINE_VERSION); runbook synthesis
  cached by hash(synthInput)+promptVersion; batch skips current-stamp guides → incremental.
…0-beta)

Pad major.minor[-pre] release tags so they're valid semver and land in the right
major. Note: TS v6 migration notes live in excluded prerelease releases — capturing
those needs selectReleases to include same-major prereleases for migration guides.
…d + cached)

Second pillar alongside migration guides: synthesises a 'how to use <pkg>' skill
from cached docs/README (stable latest version), with the same stamp + synthesis-cache
machinery. Validated on zod (Setup/Core API/Idioms/Mistakes/Example).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant