-
Notifications
You must be signed in to change notification settings - Fork 4
Devops/add link checker badge #147
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Signed-off-by: Eder Julian <Julian.Eder@infineon.com>
Signed-off-by: Eder Julian <Julian.Eder@infineon.com>
Signed-off-by: Eder Julian <Julian.Eder@infineon.com>
Signed-off-by: Eder Julian <Julian.Eder@infineon.com>
There was a problem hiding this 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 |
ramya-subramanyam
left a comment
There was a problem hiding this 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.
| > This project is work in progress. Currently not all PSOC™ 6 products & features are supported in Arduino. Please refer to the docs for further information. | ||
| ## Getting Started | ||
|
|
||
| [**Explore the docs**](https://arduino-core-psoc6.readthedocs.io/en/latest/) |
There was a problem hiding this comment.
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?
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.