Skip to content

docs: repair changelog sentences broken by the dash removal - #1306

Merged
BryanFRD merged 1 commit into
mainfrom
docs/changelog-prose
Oct 10, 2026
Merged

BryanFRD merged 1 commit into
mainfrom
docs/changelog-prose

Conversation

@BryanFRD

Copy link
Copy Markdown
Contributor

Closes #1305

Repairs sentences in docs/site/changelog/ that stopped parsing when dashes were replaced mechanically. Fixes use commas, parentheses or a light rephrase; prose that read fine is untouched, as are code blocks, inline code and every frontmatter field other than title and summary.

Kinds of fix:

  • colon pairs that framed a parenthetical turned back into parentheses (cosign-bundles, tags-before-releases, api-own-domain, action-input-hardening, commit-formats, cabal-cmake-formats, doctor, jobs-flag, persistent-release-pr, arm-targets, verified-installs, hook-release-url, migrate-js-yaml, migrate-more-tools, changesets-workspace-discovery, hook-all-packages, declarative-publishers)
  • a colon introducing a "so", "which" or "and" clause turned into a comma (publish-tag-scope, selfhosted-forge-autodetect, schema-subcommand, doctor, migrate-semantic-release, telemetry-removed, breaking-change-variants, hosted-api, jobs-flag)
  • fragments split off by a full stop merged back (bot-release-rulesets, commit-graph, concurrent-release-replan, rich-hook-context, diff-package-scope, mit-license, commit-formats, persistent-release-pr)

30 of 82 files changed. The declarative-publishers summary also had an en dash in a version range on the edited line, now v5.4 to v5.7.

@BryanFRD
BryanFRD enabled auto-merge (squash) October 10, 2026 11:19

@ferrfleet ferrfleet Bot 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.

All 30 repairs read correctly now: the stray colons and orphaned "Which"/"And" sentence fragments are back to parentheses or commas, and the front-matter summary/title values stay valid YAML. One wording nit inline, nothing blocking.

---
title: 'FerrFlow: Hosted API for validate, preview, schema and releases'
summary: 'A new hosted API at api.ferrlabs.com/v1/ferrflow/* lets you validate a config, preview version bumps and changelog, fetch the config JSON Schema, and resolve the latest release: over HTTP, with results identical to the CLI.'
summary: 'A new hosted API at api.ferrlabs.com/v1/ferrflow/* lets you validate a config, preview version bumps and changelog, fetch the config JSON Schema, and resolve the latest release, over HTTP, with results identical to the CLI.'

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.

Nit: the comma before "over HTTP" makes it read as if only the latest-release lookup is over HTTP. The original colon applied it to the whole list.

Suggested change
summary: 'A new hosted API at api.ferrlabs.com/v1/ferrflow/* lets you validate a config, preview version bumps and changelog, fetch the config JSON Schema, and resolve the latest release, over HTTP, with results identical to the CLI.'
summary: 'A new hosted API at api.ferrlabs.com/v1/ferrflow/* lets you validate a config, preview version bumps and changelog, fetch the config JSON Schema, and resolve the latest release over HTTP, with results identical to the CLI.'

@BryanFRD
BryanFRD merged commit 1b75e71 into main Oct 10, 2026
31 checks passed
@BryanFRD
BryanFRD deleted the docs/changelog-prose branch October 10, 2026 11:21
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.

Changelog entries carry sentences broken by a mechanical dash removal

1 participant