Skip to content

standalone release notes section#266

Merged
heskew merged 1 commit intomainfrom
release-notes-pages
Aug 21, 2025
Merged

standalone release notes section#266
heskew merged 1 commit intomainfrom
release-notes-pages

Conversation

@heskew
Copy link
Member

@heskew heskew commented Aug 19, 2025

reworking the release notes to be an unversioned section of docs. cleaning up current versioned release notes will come in a followup pr.

Screenshot 2025-08-19 at 7 22 24 PM

initial spike description:

getting an idea of what could work...ux feels a little rough (how many places does it need to say 'release notes') but dx improved. one possible direction for #249. this essentially puts a single copy of all release notes at /release-notes, outside of the versioned docs, and removes the sidebar_position from each release note (sidebar pos handled differently here).

in absence of a pr preview this can be previewed locally with a few steps:

  1. download the github-pages build artifact for this pr, https://github.com/HarperDB/documentation/actions/runs/17059205301?pr=266#artifacts
  2. extract and open artifact
  3. create/empty build dir in local documentation repo
  4. copy artifact contents into local build dir
  5. run npm run serve
  6. browser should open to localhost:3000. go to http://localhost:3000/release-notes
image

@heskew heskew force-pushed the release-notes-pages branch 2 times, most recently from ec3320d to fd392b7 Compare August 20, 2025 02:23
@heskew heskew changed the title [wip] release notes *pages* spike standalone release notes section Aug 20, 2025
@heskew heskew marked this pull request as ready for review August 20, 2025 02:32
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces a standalone release notes section outside of versioned documentation, creating a dedicated unversioned documentation area for release notes. The changes restructure how release notes are organized and accessed, moving them from the versioned docs structure to their own independent section.

  • Creates a new standalone release notes documentation plugin at /release-notes
  • Reorganizes all release notes from v1-v4 into version-specific folders with proper hierarchy
  • Updates navigation to include a dedicated Release Notes link in the main navbar

Reviewed Changes

Copilot reviewed 145 out of 149 changed files in this pull request and generated 3 comments.

File Description
sidebarsReleaseNotes.ts Creates new sidebar configuration for standalone release notes with version-based categories
release-notes/**/*.md Migrates all release notes from v1 through v4 into new organized folder structure
redirects.ts Adds structure for release notes redirects and reorganizes redirect generation
docusaurus.config.ts Configures new release notes documentation plugin and adds navbar link

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@heskew heskew force-pushed the release-notes-pages branch from fd392b7 to 68c2699 Compare August 20, 2025 02:40
@heskew
Copy link
Member Author

heskew commented Aug 21, 2025

getting this in now, ahead of the next release note(s)

@heskew heskew merged commit 50b55c6 into main Aug 21, 2025
2 checks passed
@heskew heskew deleted the release-notes-pages branch August 21, 2025 13:51
@kriszyp
Copy link
Member

kriszyp commented Aug 21, 2025

haha, this is awesome! Well, now I better get to work on 4.5.24 release notes! thank you!

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.

3 participants