dstack icon indicating copy to clipboard operation
dstack copied to clipboard

Prevent broken links in `dstack` docs

Open jvstme opened this issue 1 year ago • 2 comments

dstack docs often contain broken links that hurt the user experience. To prevent broken links, these measures are suggested:

  • Build docs in strict mode (mkdocs build -s) so that pipelines fail if there are broken links
  • Build docs in pull request pipelines (without publishing or with publishing to a staging environment) to prevent merging changes that break links
  • In doc files, only use local links and avoid using full self-referencing URLs (https://dstack.ai/docs/...)
  • See if building in strict mode fails when there are broken anchor links. If not, come up with a solution
  • See if there are solutions to check external links when building

jvstme avatar Aug 21 '24 17:08 jvstme

This issue is stale because it has been open for 30 days with no activity.

github-actions[bot] avatar Sep 21 '24 01:09 github-actions[bot]

This issue was closed because it has been inactive for 14 days since being marked as stale. Please reopen the issue if it is still relevant.

github-actions[bot] avatar Oct 05 '24 01:10 github-actions[bot]

This issue is stale because it has been open for 30 days with no activity.

github-actions[bot] avatar Nov 16 '24 02:11 github-actions[bot]

This issue is stale because it has been open for 30 days with no activity.

github-actions[bot] avatar Feb 03 '25 01:02 github-actions[bot]

This issue was closed because it has been inactive for 14 days since being marked as stale. Please reopen the issue if it is still relevant.

github-actions[bot] avatar Apr 20 '25 02:04 github-actions[bot]

This issue is stale because it has been open for 30 days with no activity.

github-actions[bot] avatar May 22 '25 02:05 github-actions[bot]

This issue was closed because it has been inactive for 14 days since being marked as stale. Please reopen the issue if it is still relevant.

github-actions[bot] avatar Jun 05 '25 02:06 github-actions[bot]