Docs: Standardize release notes titles and headers to "Release Notes" - #394
Open
kiran1287 wants to merge 1 commit into
Open
Docs: Standardize release notes titles and headers to "Release Notes"#394kiran1287 wants to merge 1 commit into
kiran1287 wants to merge 1 commit into
Conversation
Renames all-releases.mdx to <version>-release.mdx per version line, updates sidebar titles and in-page H1s from "X.Y Release(s)" to "X.Y Release Notes" (and "Latest Release Notes" for the pages tracking the current shipping version), truncates frontmatter titles to end at "OpenMetadata", renames the "All Releases" nav group to "All Release Notes", and fixes a broken snippet import in v1.12.x/releases.mdx. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
5 tasks
5 tasks
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for 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
1 participant
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.
Summary
all-releases.mdxto<version>-release.mdxper version line (v1.12.x,v1.13.x,v2.0.x-SNAPSHOT), consistent with the naming already used for older minor-version pagesX.Y Release(s)toX.Y Release Notes,Old ReleasestoOlder Release Notes, andLatest ReleasetoLatest Release Notesfor the pages tracking the current shipping versiontitle:field to end atOpenMetadata(dropping the redundant trailingX.Y Releasessuffix)"All Releases"nav group indocs.jsonto"All Release Notes"(3 occurrences)v1.12.x/releases.mdx(1.2.14.mdx→1.12.14.mdx) found during review — the typo'd path pointed at a file that doesn't existTest plan
docs.jsonvalidated as well-formed JSONlatest.mdxget "Latest Release Notes"; the frozen v1.12.x page correctly gets "1.12 Release Notes" instead)