smartcontractkit/documentation

[Enhancement]: Validate external links

Closed this issue · 1 comments

What would you like us to improve?

Currently, the link checker successfully checks internal links without encountering any errors.

However, when external link checking is enabled, the link checker identifies 536 warnings and 77 errors. To ensure thorough link validation, it is important to enable external link checking and address both the warnings and errors found during the process.

How important it is?

Enabling external link checking and handling errors is important in order to provide accurate and reliable information to users.

Link checker reports various failures when checking external links:
HTTP 404, HTTP 403, HTTP 410: I suggest replacing or deleting links that receive these response statuses (there are numerous instances).
HTTP 500, HTTP 308, HTTP 200 but missing anchor, connection failed: I recommend disregarding these error messages since the pages function correctly when checked manually.

I could attempt to replace or delete links that have an HTTP 4xx response status, or I could create a list of broken links along with their replacements.

@dwightjl, could you please share your opinion on how I should proceed?