Repository navigation
Prevent broken links in dstack docs #1603
Description
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 - Ensure they do actually fail on broken links (didn't fail here)
- 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
Activity
github-actions commentedon Sep 21, 2024
This issue is stale because it has been open for 30 days with no activity.
github-actions commentedon Oct 5, 2024
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 commentedon Nov 16, 2024
This issue is stale because it has been open for 30 days with no activity.
[Docs] Prevent broken links in dstack docs #1603 (review suggestions)
Improve docs (#2135)
github-actions commentedon Feb 3, 2025
This issue is stale because it has been open for 30 days with no activity.
Improve docs (dstackai#2135)
Improve docs (dstackai#2135)
Improve docs (dstackai#2135)
github-actions commentedon Apr 20, 2025
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 commentedon May 22, 2025
This issue is stale because it has been open for 30 days with no activity.
github-actions commentedon Jun 5, 2025
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.