Skip to content

[Change] docs-14 - Publish-Driven Module Release History And Docs Rendering #124

@djm81

Description

@djm81

Why

The modules docs homepage currently tells users what each official module does, but it does not answer the more operational question: which module versions have been published recently, and what features or improvements each release shipped. The repository-level CHANGELOG.md is not a good source for that view because it is prose-first, repo-level, and not consistently structured per module/version. The publish workflow already updates registry/index.json whenever a module is released, so release-history metadata should be captured in the same publish path and then rendered in docs from repository data without dynamic loading.

Already-published module versions also need historical coverage so the feature is useful from day one. That requires a one-time backfill from existing repo evidence with AI-assisted extraction, followed by a stable structured format for future publishes. OpenSpec project rules should also be tightened so release-history extraction/update becomes part of the expected workflow for future module releases and docs refreshes.

What Changes

  • Define a canonical structured release-history source for official modules, separate from the lean install/search registry index
  • Extend .github/workflows/publish-modules.yml so each published module version writes a release-history entry alongside the existing registry metadata update
  • Add a one-time backfill workflow for already-published module versions using AI-assisted extraction from existing repo evidence and human-reviewable structured output
  • Let AI copilot draft module-specific release and patch notes in a regular changelog style, but constrained to clear user-facing scope, shipped value, and concise summaries rather than low-signal technical detail
  • Render recent per-module release history in the modules docs overview so users can immediately see published versions and shipped features/improvements
  • Document the authoring/publish expectations for maintaining release-history metadata
  • Update openspec/config.yaml rules so future changes involving module releases or docs synchronization account for release-history extraction/update requirements

Acceptance Criteria

  • The repo has a canonical structured release-history source for official module publishes
  • The publish workflow writes release-history entries whenever a module version is published
  • Historical published module versions can be backfilled into reviewable release-history entries
  • The modules docs overview renders published versions plus shipped features/improvements from repository data
  • AI-assisted release-note drafting stays user-focused and avoids low-signal technical filler

Dependencies

  • Depends on: modules repo docs-13 navigation/search/theme follow-up for homepage UX context
  • Related publish workflow: .github/workflows/publish-modules.yml
  • Related source data: registry/index.json

OpenSpec Change Proposal: docs-14-module-release-history

Metadata

Metadata

Assignees

Labels

change-proposalProposal for a new changedocumentationImprovements or additions to documentationenhancementNew feature or request

Projects

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions