Skip to content

Conversation

ederjc
Copy link
Member

@ederjc ederjc commented Jul 30, 2025

By creating this pull request you agree to the terms in CONTRIBUTING.md.
https://github.com/Infineon/.github/blob/master/CONTRIBUTING.md
--- DO NOT DELETE ANYTHING ABOVE THIS LINE ---

Forgot to add the README badge for link checking in #146... 🙄

While editing the README I have brought it closer to the format we have in other repositories and replaced HTML by Markdown where possible.

Copy link

@Copilot 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 adds a link checker badge to the README and modernizes the README format by replacing HTML elements with Markdown equivalents while maintaining the same content structure.

  • Added a link checker badge to display the status of the check_links workflow
  • Converted HTML formatting to Markdown for better maintainability and consistency
  • Restructured sections for improved readability while preserving all original content

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
README.md Added link checker badge and converted HTML elements to Markdown format for improved maintainability
.github/workflows/check_links.yml Added new GitHub Actions workflow to check for broken links in the repository

Copy link
Collaborator

@ramya-subramanyam ramya-subramanyam left a comment

Choose a reason for hiding this comment

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

Nice!
You can also bring these changes in README back to templates in makers-devops.


[**Explore the docs**](https://arduino-core-psoc6.readthedocs.io/en/latest/)
Copy link
Collaborator

Choose a reason for hiding this comment

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

You have removed the WIP warning here. Was this intentional? Should we also remove it from the read the docs?

@ederjc ederjc merged commit f437bc6 into main Aug 4, 2025
12 checks passed
@ederjc ederjc deleted the devops/add-link-checker-badge branch August 4, 2025 14:57
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