Skip to content

Conversation

MikeMcC399
Copy link
Contributor

Issue

The Changelog contains links from one Cypress release to another Cypress release, and in some cases the version is formatted as Markdown code. This produces a sub-optimal display of the version number, which is highlighted (as a hyperlink) and underlined (as code).

image

The document Cypress App - Managing the Release Changelog specifies in Writing Guidelines

  • If a changelog item is a regression, the description should start with Fixed a regression in [9.1.0](#9-1-0) with a link to the release that introduced it.

Change

In the Changelog remove Markdown code backticks for linked versions of Cypress for clearer highlighted display of the version number without underlining and to conform to the Writing Guidelines.

Copy link

netlify bot commented Sep 27, 2024

👷 Deploy request for cypress-docs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 7560794

@cypress-app-bot
Copy link
Collaborator

@MikeMcC399 MikeMcC399 marked this pull request as ready for review September 27, 2024 15:40
@jennifer-shehane jennifer-shehane merged commit 7e5f94a into cypress-io:main Sep 27, 2024
5 checks passed
@MikeMcC399 MikeMcC399 deleted the changelog-cypress-links branch September 27, 2024 16:24
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.

3 participants