search

meilisearch / documentation

Meilisearch documentation
https://docs.meilisearch.com
MIT License
146 stars 243 forks source link

Migration: Broken links checker #2313

Closed guimachiavelli closed 1 year ago

guimachiavelli commented 1 year ago

We currently have both a local CLI command and a GitHub action triggered on push that check for broken internal links and anchor links.

For example, if we change a page from /cli-options.mdx to /configuration-options.mdx, our checker notifies us about links pointing to the old file. The same happens for anchor links: the checker will notify us if we change a heading from ## CLI options to ## Configuration options.

@bidoubiwa wrote a quick script that could be attached to a GitHub action to check these links remotely: https://github.com/bidoubiwa/dead-links-logger

We also discussed having a local script that checks internal links (meaning, links between .mdx files) against the routes configured in sidebar-learn.json, sidebar-reference.json, and sidebar-footer.json. This script could be run locally, which would probably be more efficient than relying on pushing things to a remote repo.

Note: none of these two ideas account for anchor links.

guimachiavelli commented 1 year ago

This issue is now the responsibility of an external team and will be monitored in their preferred platform.