Skip to content

README and docs cleanup for npm publishing#39

Merged
theoephraim merged 1 commit intomainfrom
chore/readme-and-docs-cleanup
Apr 22, 2026
Merged

README and docs cleanup for npm publishing#39
theoephraim merged 1 commit intomainfrom
chore/readme-and-docs-cleanup

Conversation

@theoephraim
Copy link
Copy Markdown
Member

Summary

  • Use absolute GitHub URLs for images and doc links so they render on npmjs.com
  • Add prepack script to copy root README into the bumpy package before publish
  • Add note in bump file docs about blank descriptions being omitted from changelog
  • Remove outdated llms.md (will regenerate when docs site is ready)

Test plan

  • Verify README renders correctly on GitHub
  • Verify npm pack includes README via prepack script
  • Check doc links resolve correctly

🤖 Generated with Claude Code

@bumpy-bot
Copy link
Copy Markdown
Collaborator

bumpy-bot commented Apr 22, 2026

bumpy-frog

The changes in this PR will be included in the next version bump.

patch Patch releases

  • @varlock/bumpy 1.1.0 → 1.1.1

Bump files in this PR

Click here if you want to add another bump file to this PR


This comment is maintained by bumpy.

- Use absolute GitHub URLs for images and doc links (works on npmjs.com)
- Add prepack script to copy root README into bumpy package
- Add note about blank bump file descriptions in docs
- Remove outdated llms.md (will regenerate when docs site is ready)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@theoephraim theoephraim force-pushed the chore/readme-and-docs-cleanup branch from 659c6d0 to 8c725c5 Compare April 22, 2026 06:04
@theoephraim theoephraim merged commit befa70e into main Apr 22, 2026
2 checks passed
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.

2 participants