Skip to content

Conversation

@martincostello
Copy link
Member

Changes

  • Fix some invalid HTML.
  • Move links to not be inline.

Changes mirrored from new package README in #142.

Merge requirement checklist

  • Unit tests added/updated
  • CHANGELOG.md file updated for non-trivial changes
  • Changes in public API reviewed (if applicable)

- Fix some invalid HTML.
- Move links to not be inline.
@martincostello martincostello added the documentation Improvements or additions to documentation label Jun 5, 2025
@martincostello martincostello marked this pull request as ready for review June 5, 2025 14:53
Copilot AI review requested due to automatic review settings June 5, 2025 14:53
@martincostello martincostello requested a review from a team as a code owner June 5, 2025 14:53
@martincostello martincostello enabled auto-merge (squash) June 5, 2025 14:53
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the README to fix invalid HTML and refactor inline links into reference-style links for improved readability and maintainability.

  • Fixed invalid HTML markup.
  • Converted inline links to reference-style links.
  • Updated badge, discussion, and documentation URL references.

@martincostello martincostello merged commit 1b046a7 into main Jun 5, 2025
9 checks passed
@martincostello martincostello deleted the readme-tweaks branch June 5, 2025 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants