Skip to content

Conversation

@f-hollow
Copy link
Collaborator

@f-hollow f-hollow commented Sep 1, 2025

Description

This PR fixes most of the broken links reported in the most recent Cron job to check links weekly.

The links that are still not fixed:

  • Internal relative links, as lychee requires a special syntax for that
    • Examples: ../../../../workshops/esp-idf-with-esp32-c6/
    • Fix: Update the links to keep them checkable https://github.com/trailofbits/testing-handbook/issues/9 (need to investigate pros and cons, see also Linking pages in Hugo/markdown), or ignore internal links as suggested in https://github.com/lycheeverse/lychee/issues/1646
    • Note: Set lychee to ignore internal links; consider using a more specialized tool for that like broken-link-checker
  • For GitHub links, the suffixes #anchor are not checked correctly
    • Examples: https://github.com/espressif/esp-jumpstart/blob/master/4_network_config/main/app_main.c#L215 and https://github.com/espressif/esp-aws-iot/tree/release/beta/examples#configuring-your-device
    • Fix: No recommended solution for now, see https://github.com/lycheeverse/lychee/issues/1791 and https://github.com/lycheeverse/lychee/issues/1729
    • Similar: products.espressifl.com presents the same challenge
    • GitHub processes such anchors in a non-standard way; might be worth trying a headless browser in CI for checking such links
  • Links that load indefinitely
    • Examples: https://pycom.io/, https://www.smarthomeexpo.in/why-smart-home-expo.php, etc.
    • Fix: Review the content and remove the links if possible
  • Getting Started with Wi-Fi on ESP-IDF
    • The links to be fixed: https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/event-handling.html#event-handling and https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/network/esp_netif.html?highlight=ip_event#_CPPv410ip_event_t
    • Fix: Not sure who to ask for help
  • Note: Links waiting for replies from content authors:

Related

Testing


Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

@f-hollow f-hollow force-pushed the fix/update_broken_links branch 4 times, most recently from b1e7f3d to 78f66fa Compare September 3, 2025 11:28
@f-hollow f-hollow force-pushed the fix/update_broken_links branch from 78f66fa to aedeb05 Compare September 3, 2025 11:38
@f-hollow f-hollow merged commit fbfeac5 into espressif:main Sep 4, 2025
7 checks passed
@f-hollow f-hollow deleted the fix/update_broken_links branch September 4, 2025 02:35
@f-hollow f-hollow mentioned this pull request Sep 16, 2025
6 tasks
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.

2 participants