Conversation
kimsauce
changed the title
kimsauce
changed the title
kimsauce
changed the title
kimsauce
changed the title
…tyle guide Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Make this section the single source of truth for how release notes are written across all five blog folders. Restructure it into Writing style (shared rules plus the no-marketing-language do/don't table), Structure and frontmatter, and a Per-folder conventions table that replaces the interleaved per-type exceptions in the old numbered steps. Standardize the title date format to `Month D, YYYY` (full month name, no ordinal, no leading zero), per the Dates section. State that the `YYYY-MM-DD-` filename prefix is required because the Docusaurus blog plugin derives the publish date and sort order from it. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Trim the five release-note-*.md commands and the sumo-style skill so
editorial guidance lives only in the style guide. Remove restated voice,
conciseness, and "Learn more" bullets, and the date rules that are now
wrong after the Month D, YYYY standardization: the Cloud SIEM "use
ordinal suffixes" rules and `{Day}th` placeholder, the Cloud SOAR
"zero-padded day" rules and examples, and the Collector checklist line
that still said 'Starts with "We're excited to..."'. Each spot now links
to /docs/contributing/style-guide/#release-notes. Mechanical scaffolding
(heading levels, [New]/[Updated] tags, CVE format, frontmatter blocks,
workflow steps) is unchanged.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
kimsauce
marked this pull request as ready for review
September 10, 2026 22:39
kimsauce
requested review from
JV0812,
amee-sumo and
mafsumo
as code owners
September 10, 2026 22:39
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.
Purpose of this pull request
From UAT: 60% of Mindtouch-to-Docusaurus testers had trouble navigating release note categories. DOCS-12 is the follow-up to improve release note consistency and discoverability; this PR is the consistency half.
Makes the style guide's Release notes section the single source of truth for how release notes are written across all five blog folders (Service, Collector, Cloud SIEM, Cloud SOAR, Developer). Rewrites it into:
Month D, YYYYper the Dates section.YYYY-MM-DD-filename prefix, truncating long notes, and the two release-note-specific frontmatter fields.Also trims the five
.claude/commands/release-note-*.mdtemplates and thesumo-styleskill to reference this section instead of restating it.Select the type of change
Ticket (if applicable)
https://sumologic.atlassian.net/browse/DOCS-12