Conversation
ec3320d to
fd392b7
Compare
There was a problem hiding this comment.
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.
fd392b7 to
68c2699
Compare
Member
Author
|
getting this in now, ahead of the next release note(s) |
Member
|
haha, this is awesome! Well, now I better get to work on 4.5.24 release notes! thank you! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
reworking the release notes to be an unversioned section of docs. cleaning up current versioned release notes will come in a followup pr.
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:
github-pagesbuild artifact for this pr, https://github.com/HarperDB/documentation/actions/runs/17059205301?pr=266#artifactsnpm run serve