Skip to content

docs: add changelog/release surface, badges, and LICENSE attribution - #41

Merged
timimsms merged 1 commit into
mainfrom
docs/release-surface
Jul 17, 2026
Merged

docs: add changelog/release surface, badges, and LICENSE attribution#41
timimsms merged 1 commit into
mainfrom
docs/release-surface

Conversation

@timimsms

Copy link
Copy Markdown
Owner

Summary

  • Changelog page on the docs site, auto-regenerated from GitHub Releases on every deploy — the deploy workflow now also triggers on release: published, so the page refreshes the moment a release ships with zero manual edits. Bullets are cleaned (commit SHAs and author emails stripped, per-release install footers trimmed). A committed snapshot keeps mkdocs build --strict green in CI and locally.
  • Release badges on README and the docs homepage (shields.io, auto-updates per release).
  • LICENSE attribution updated to Copyright (c) 2025-2026 Tim Walsh.

Test plan

  • mkdocs build --strict passes locally with the new page and nav entry
  • Generation pipeline (gh api + jq + sed) run locally — output verified free of SHAs/emails
  • Both edited workflows/YAML parse
  • CI green
  • Post-merge: Deploy Documentation run regenerates and publishes /changelog/

🤖 Generated with Claude Code

- New docs/site/changelog.md generated from GitHub Releases (SHA/author
  noise stripped, install footer trimmed); committed snapshot keeps
  strict builds green while the deploy workflow regenerates it fresh
- deploy-docs.yml: regenerate changelog at build time and also deploy
  on release publication, so the page updates the moment a release ships
- Release badges on README and the docs homepage; changelog linked
  from nav and Next Steps
- LICENSE: Copyright (c) 2025-2026 Tim Walsh

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@timimsms
timimsms merged commit d1fe415 into main Jul 17, 2026
16 checks passed
@timimsms
timimsms deleted the docs/release-surface branch July 17, 2026 03:24
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