-
Notifications
You must be signed in to change notification settings - Fork 239
Updates navigation titles for release notes #4526
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this 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 updates the navigation titles for the Known issues and Breaking changes pages in the release notes to better reflect the content of each page.
- Updates the navigation title in docs/release-notes/known-issues.md to "Known issues".
- Updates the navigation title in docs/release-notes/breaking-changes.md to "Breaking changes".
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/release-notes/known-issues.md | Changed navigation title to "Known issues" for clarity |
| docs/release-notes/breaking-changes.md | Changed navigation title to "Breaking changes" for clarity |
trentm
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
colleenmcginnis
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✨
|
@trentm to save real estate in the left nav, we're display only the product names for the top level release notes pages. When you view the top level release notes pages, the titles include Here is an idea of what everything will look like when organized in the
|
@KOTungseth IIUC using the product name here is primarily for a section of the grouped docs that just presents the Release Notes for all the products. There the context that these are "Release Notes" is clear, granted. My issue / use case / question is for when a user is looking at just the docs for a given produce, e.g. the Node.js APM agent: How does the user know what TOC item to select to view "release notes", or "what has changed recently", or "changelog"? |
The layout you linked to will only ever be available in PR previews. In the production docs, users will see our global IA. Here's what the Observability part of the Release notes section looks like right now (before this PR is merged).
This screenshot was taken from building the entire docs site locally. We're trying to get all these pieces together so we can get the complete IA on staging (so it's a bit of a 🐔 🥚). |



Updates the navigation titles for Known issues and Breaking changes pages in the release notes.
Checklist
docs/release-notes/index.md