Skip to content

Improve heading choice in release notes#344

Open
ndyer wants to merge 1 commit into
canonical:mainfrom
ndyer:fix/release-notes
Open

Improve heading choice in release notes#344
ndyer wants to merge 1 commit into
canonical:mainfrom
ndyer:fix/release-notes

Conversation

@ndyer

@ndyer ndyer commented May 19, 2026

Copy link
Copy Markdown
Contributor

This aligns better with the heading levels and prevents "New in snapd 2.74" appearing in the sidebar.

@ndyer ndyer requested a review from olivercalder May 19, 2026 15:49
Rnfudge02
Rnfudge02 previously approved these changes May 19, 2026

@Rnfudge02 Rnfudge02 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks!

@Rnfudge02 Rnfudge02 self-requested a review May 19, 2026 20:44
@Rnfudge02 Rnfudge02 dismissed their stale review May 19, 2026 20:44

Built project, one question

@Rnfudge02

Copy link
Copy Markdown
Contributor

Upon closer inspection, it seems it doesn't remove it from the Contents column, if that is what you meant by sidebar. I agree this is a better heading, but I think it may need an extra indent level if you want it to disappear from there

image

@olivercalder olivercalder left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Question about matching other recent release notes.

We’re pleased to share that Snapd 2.74 snap is available for testing in the beta channel.

# New in snapd 2.74
### New in snapd 2.74

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

2.72 and 2.73 have release notes like this:

Suggested change
### New in snapd 2.74
(ref-release-notes_snapd-2-74-release-notes)=
## Snapd 2.74 release notes

Should we match the same format here?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think we had decided to use markdown style formatting consistently across the project recently, maybe this was the old style?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I think you may be right, my analysis of the issue is wrong.

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