Skip to content

docs: add curated highlights to 2026 Cloud release notes - #2764

Draft
claudiacodacy wants to merge 8 commits into
masterfrom
docs/release-notes-2026-highlights
Draft

claudiacodacy wants to merge 8 commits into
masterfrom
docs/release-notes-2026-highlights

Conversation

@claudiacodacy

Copy link
Copy Markdown
Contributor

Summary

  • Opens each 2026 monthly Cloud release note (cloud-2026-01.md through cloud-2026-08.md) with a short headline paragraph naming the month's most notable feature and why it matters, followed by a one-sentence "Also this month" round-up of the rest — inspired by the Claude Code "What's new" digest.
  • Adds a matching one-line highlight next to each of those 8 entries in docs/release-notes/index.md, so scanning the index gives the same at-a-glance value.
  • Deliberately scoped to the 8 monthly roundups only — single-topic announcement pages (e.g. the Oxlint or Semgrep migration notes) already cover one topic and are left as-is.

This is the smallest version of a larger proposal to bring a Claude-style curated digest to our release notes; see conversation for the full write-up and what was deliberately left alone (the monthly Features/Improvements/Tool versions structure, which stays the "full changelog" layer).

Test plan

  • mkdocs build --strict — passes with no new warnings or errors
  • vale on all 9 changed files — flags pre-existing, already-accepted patterns in this content type (spaced em dashes, product names like Semgrep/Opengrep, "walkthrough"), consistent with unedited text elsewhere in the same files; no new categories of finding introduced
  • Voice/tone review by a human — the highlight paragraphs are new prose and worth a second read

🤖 Generated with Claude Code

Opens each 2026 monthly Cloud roundup with a short headline feature and
"why it matters" framing, then bundles the rest of the month's changes
in one sentence, inspired by the Claude Code "What's new" digest.
Mirrors the same highlight as a one-line summary next to each 2026
entry in the release notes index.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Overall readability score: 54.13 (🔴 -0.01)

File Readability
index.md 56.84 (🔴 -23.87)
cloud-2026-09-adding-oxlint.md 46.35 (🟢 +1.25)
cloud-2026-08.md 65.1 (🟢 +0.9)
cloud-2026-07.md 65.13 (🔴 -0.27)
cloud-2026-07-remove-codesniffer-packages.md 35.32 (🔴 -3.75)
cloud-2026-07-adding-shellcheck-config-file.md 55.35 (🟢 +2.74)
cloud-2026-07-adding-phpcsfixer-checkov-config-files.md 49.88 (🟢 +3.5)
cloud-2026-06.md 56.82 (🔴 -0.32)
cloud-2026-05.md 60.27 (🟢 +3.16)
cloud-2026-04.md 53.72 (🔴 -1.32)
cloud-2026-03.md 56.17 (🟢 +2.15)
cloud-2026-03-github-integration-settings-changes.md 51.69 (🟢 +0.44)
cloud-2026-02.md 46.11 (🟢 +1.04)
cloud-2026-02-migrating-semgrep.md 44.33 (🟢 +8.44)
cloud-2026-01.md 50.29 (🟢 +2.87)
cloud-2026-01-adding-golangci-lint.md 54.68 (🔴 -0.36)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
index.md 56.84 55.54 10.5 12.9 12.82 7.53
  🔴 -23.87 🔴 -29.34 🔴 -3.35 🔴 -2.8 🔴 -3.61 🔴 -1.28
cloud-2026-09-adding-oxlint.md 46.35 32.19 10.5 13.3 14.67 8.6
  🟢 +1.25 🔴 -0.81 🟢 +0.32 🔴 -0.2 🔴 -0.18 🟢 +0.43
cloud-2026-08.md 65.1 58.89 8.64 11.1 11.7 7.43
  🟢 +0.9 🔴 -0.61 🟢 +0.04 🟢 +0 🟢 +0.23 🟢 +0.19
cloud-2026-07.md 65.13 59.4 8.34 11.1 12.22 7.38
  🔴 -0.27 🔴 -1.01 🔴 -0.04 🔴 -0.4 🔴 -0.41 🟢 +0.35
cloud-2026-07-remove-codesniffer-packages.md 35.32 35.07 13.51 15.7 15.72 9.03
  🔴 -3.75 🔴 -1.01 🔴 -0.38 🔴 -1.4 🔴 -0.93 🟢 +0.13
cloud-2026-07-adding-shellcheck-config-file.md 55.35 35.34 9.52 11 13.84 7.89
  🟢 +2.74 🔴 -0.3 🟢 +0.94 🔴 -0.4 🔴 -0.76 🟢 +0.88
cloud-2026-07-adding-phpcsfixer-checkov-config-files.md 49.88 28.43 11.1 13.3 13.16 7.65
  🟢 +3.5 🟢 +0.2 🟢 +0.66 🟢 +0.4 🟢 +0.24 🟢 +0.44
cloud-2026-06.md 56.82 41.46 9.65 11.5 13.09 7.78
  🔴 -0.32 🔴 -9.07 🟢 +0.37 🔴 -0.4 🔴 -0.11 🟢 +0.4
cloud-2026-05.md 60.27 51.04 8.65 11.4 12.63 7.98
  🟢 +3.16 🔴 -0.4 🟢 +0.33 🟢 +0.5 🟢 +0.28 🟢 +0.48
cloud-2026-04.md 53.72 49.11 10.29 12.5 13.51 8.16
  🔴 -1.32 🔴 -1.12 🟢 +0.15 🔴 -0.9 🔴 -0.88 🟢 +0.36
cloud-2026-03.md 56.17 47.59 11.34 11.4 11.59 8.1
  🟢 +2.15 🔴 -1.11 🟢 +0.32 🔴 -0.3 🟢 +0.23 🟢 +0.59
cloud-2026-03-github-integration-settings-changes.md 51.69 28.74 10.59 13.3 13.63 7.17
  🟢 +0.44 🔴 -0.1 🟢 +0.15 🔴 -0.1 🔴 -0.12 🟢 +0.16
cloud-2026-02.md 46.11 39.84 11.31 13.5 14.32 8.7
  🟢 +1.04 🔴 -10.08 🟢 +0.7 🔴 -0.9 🔴 -0.65 🟢 +1.16
cloud-2026-02-migrating-semgrep.md 44.33 36.28 12.76 14.4 14.32 7.89
  🟢 +8.44 🟢 +3.04 🟢 +2.78 🟢 +0.5 🔴 -0.8 🟢 +1.11
cloud-2026-01.md 50.29 47.59 10.92 12.8 13.39 8.73
  🟢 +2.87 🔴 -2.03 🔴 -0.19 🔴 -0.3 🟢 +0.4 🟢 +1.06
cloud-2026-01-adding-golangci-lint.md 54.68 34.52 10.49 10.3 12.28 8.54
  🔴 -0.36 🔴 -8.97 🟢 +0.5 🔴 -0.6 🔴 -0.29 🟢 +0.48

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.13 42.76 10.9 12.37 12.3 7.97
  🔴 -0.01 🔴 -0.23 🟢 +0.01 🔴 -0.03 🔴 -0.03 🟢 +0.03
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@codacy-production

Copy link
Copy Markdown
Contributor

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

@github-actions
github-actions Bot temporarily deployed to Netlify September 25, 2026 12:44 Inactive
Replaces the hand-duplicated one-line summary in the index with a
transcluded snippet from each monthly page's own opening paragraph,
marked with <!--highlight--> / <!--/highlight--> comments. Uses the
include-markdown plugin already installed in this repo (previously
only used for docs/assets/includes/ boilerplate, not page-to-page),
so the highlight text lives in exactly one place and can't drift.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions
github-actions Bot temporarily deployed to Netlify September 25, 2026 12:53 Inactive
Wraps each highlighted entry's body in a release-digest__body span and
extends the existing #codacy-release-notes list styling in home.css
with a two-column grid (period label, then digest content) for rows
that carry a highlight, inspired by the Claude Code "What's new" page.
Entries without a highlight (single-topic announcements, older years)
are untouched and keep rendering as plain rows.

Verified in the browser: light and dark color schemes at desktop
width, and dark scheme at mobile width where the grid collapses to a
single column via the new responsive.css rule.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions
github-actions Bot temporarily deployed to Netlify September 25, 2026 13:12 Inactive
Adds a <!--highlight--> snippet to the 7 remaining 2026 single-topic
release notes (Oxlint, Shellcheck config, PHP CS Fixer/Checkov config,
PHP_CodeSniffer upgrade, GitHub integration changes, Semgrep/Opengrep,
GolangCI-Lint client-side) and wires them into index.md the same way
as the monthly roundups, so every 2026 entry uses the same two-column
digest treatment instead of only the 8 monthly ones.

Verified in the browser: all 15 entries transclude and render
correctly, the list transitions cleanly into the untouched 2025
section, and long titles (PHP CS Fixer/Checkov) wrap without breaking
the grid.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions
github-actions Bot temporarily deployed to Netlify September 25, 2026 13:18 Inactive
Replaces each 2026 entry's link text (previously the page's own title,
ranging from a plain "Cloud August 2026" to a full sentence like
"PHP_CodeSniffer Upgrade and Legacy Package Deprecations July, 2026")
with just its "Month Year". The topic already lives in the transcluded
highlight's bold lead-in, so the old title was duplicating it while
also making the label column wildly inconsistent in length. Every row
now has a uniform, single-line label, closer to how the Claude Code
"What's new" page separates the period from the content.

Verified in the browser: light and dark schemes, full list scroll
including the four same-month July rows and the 2026/2025 boundary.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions
github-actions Bot temporarily deployed to Netlify September 25, 2026 13:25 Inactive
Replaces the {% include-markdown %} calls in index.md with the same
highlight text written directly in the list — simpler than keeping a
build-time dependency between 15 source files and the index for a
page that, once published, rarely changes. The <!--highlight--> /
<!--/highlight--> markers are removed from all 15 source pages; the
sentence itself stays as a plain intro paragraph on each page.

Also:
- Drops the leading em dash before each digest body — the two-column
  grid already separates the date from the content, so it was
  redundant.
- Fixes the bullet dot's vertical alignment on digest rows: it was
  centered for the old single-line row height and sat visibly above
  the label once rows grew to 2-4 lines.

Verified in the browser: rebuilt getComputedStyle numbers show the dot
is now centered on the label's first line (0.26px off, previously
~5px), and checked light/dark rendering of the full 2026 list.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions
github-actions Bot temporarily deployed to Netlify September 25, 2026 13:37 Inactive
- Removes the ::before bullet dot from the release notes list entirely
  (both plain and digest rows) instead of re-tuning its position, and
  tightens the now-unneeded left padding that made room for it.
- Replaces "Month Year" labels with the actual day, pulled from git
  history (the commit that first added each file) rather than
  invented. Flagging one anomaly in the handoff: the January roundup's
  git date falls inside the month it summarizes rather than after it,
  unlike every other monthly roundup.
- For months with more than one main feature, names all of them
  instead of just the headline one, while leaving bug fixes and minor
  improvements out — matches the Features/Improvements split already
  used on the June/July/August pages, applied by judgment on the
  earlier months that only have a flat "Product enhancements" list.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions
github-actions Bot temporarily deployed to Netlify September 25, 2026 13:51 Inactive
For months with more than one main feature, each now gets its own
bold-led paragraph (separated by a blank line) using the wording from
that page's own Features/Product enhancements section, rather than
being paraphrased into one run-on "Also new: ..." sentence. Dropped
internal ticket references (OD-xxx, CF-xxx, TCE-xxx) since they're not
meaningful to an external reader, and the one instance of "robust"
(banned by voice.md) in the January entry.

Also removes the bold weight from the date label — it now matches the
rest of the list's link styling, just distinguished by color.

Verified in the browser: all 15 entries render with clean paragraph
spacing at the row heights this produces (August and July now run
4 paragraphs each), and confirmed via get_page_text/screenshots that
content earlier screenshots seemed to cut off was a scroll-timing
artifact, not a rendering bug — the full HTML output was always
complete.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

This branch was successfully deployed

1 active deployment
Netlify — ed4b1c4b Deployed Sep 25, 2026 by github-actions[bot]
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.

1 participant