Repository navigation
[Trace] Broken links: fix dead links in the docs site - #169
Merged
Merged
Conversation
Fixed broken internal links across docs site: - 25 Wrike integration links (converted relative paths to absolute /docs/ paths) - 6 Pipelines links (converted relative paths to absolute /docs/ paths) - 5 TurboDocx Templating links (converted relative paths, removed non-existent page links) - 3 TurboQuote links (converted relative paths) - 2 Dashboard links (converted relative paths) - 2 TurboSign links (converted relative/absolute paths) Reduced broken links from 56 to 19 (13 in SDK files owned by other PR, 2 commented-out images, 1 directory link in Webhooks). Excluded from fixes: - Links within docs/SDKs/ and docs/API/ (owned by SDK/API enrichment PRs) - Redirected external links that resolve to current URLs - Rate-limited or auth-gated external URLs (false positives) Test plan: - Before: 56 broken links found - After: 19 broken links (all in SDK files or commented content) - Internal link fixes: ./path -> /docs/path conversion - Removed broken links to non-existent pages, keeping text
added 2 commits
September 23, 2026 07:04
The broken-link checker resolved Docusaurus file-relative links (./setting-up-automation.md, ../../TurboSign/Webhooks.md) against the site root instead of the source file's directory, so it flagged many working links as broken. This reverts those 25 files back to their original relative links, which resolve correctly on the live site. It also removes the '(coming soon)' text the previous commit added for genuinely dead links, since that publicly promises features that may not exist (one of them, Webhook Integration, already has a real page). The three files with real dead links now either point to the correct existing page or have the dead bullet removed: - Webhook Integration / Webhook Configuration -> /docs/TurboSign/Webhooks - Bulk Document Generation / Bulk Processing -> removed (no matching page) - Template Version Management -> removed (no matching page) - Template Management Guide -> removed (no matching page) - Integration Examples -> removed (/docs/Integrations 404s live; no index page exists for it) - API Authentication -> reverted to /docs/API/turbodocx-api-documentation (the original target, confirmed live 200; the previous commit had pointed it at /docs/API/Deliverable%20API instead)
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #168
Trace task: broken-links trace job from AI SEO Playbook
Correction to the original pass: the broken-link checker resolved Docusaurus
file-relative links (
./setting-up-automation.md,../../TurboSign/Webhooks.md)against the site root instead of the linking file's own directory, so it misreported
many working links as broken. The "56 broken links" figure was inflated. Verified live:
docs/Integrations/Wrike/index.md's./setting-up-automation.mdrenders ashttps://docs.turbodocx.com/docs/Integrations/Wrike/setting-up-automationand returns200.
This revision reverts the 25 files where the report was a false positive back to their
original, working relative links (no more churn converting
./foo.mdto/docs/.../foo), and keeps only the genuinely broken links, fixed properly:Real fixes (3 files:
docs/TurboDocx Templating/API Templates.md,docs/TurboDocx Templating/ai-variable-generation.md,docs/TurboSign/API Signatures.md):Webhook Integration for Status Updates/Webhook Configuration/Webhook Integration:/docs/Webhooks/webhook-configuration(does not exist) →/docs/TurboSign/Webhooks(exists, confirmed 200 live)API Authentication: reverted to its original, working target/docs/API/turbodocx-api-documentation(confirmed 200 live) — the previous commit hadincorrectly repointed it to
/docs/API/Deliverable%20APIBulk Document Generation/Bulk Processing: linked to/docs/Templates/bulk-generation, which doesn't exist and has no equivalent page —bullet removed
Template Version Management: linked to/docs/Templates/version-control, noequivalent page — bullet removed
Template Management Guide: linked to/docs/Templates/template-management, noequivalent page — bullet removed
Integration Examples: linked to/docs/Integrations, which is configured as aDocusaurus generated-index category page but 404s live — no working page to point to,
bullet removed
None of these got "(coming soon)" text — that publicly promises features/docs that may
never exist, and in at least one case (
Webhooks.md) the referenced feature already hasreal documentation, so the placeholder text would have been false.
Reverted (false positives, 25 files): Wrike integration guides (15), Pipelines guides
(6), TurboDocx Templating (
Brand Identity.md,Template Troubleshooting.md), TurboQuote(
Bulk Importing from a Spreadsheet.md,Prepared By and Sender Identity.md), andDashboard.md. All of these had working relative.mdlinks converted to absolute/docs/...paths for no reason; both forms resolve identically under Docusaurus, so thiswas pure churn. Every target file's existence was checked on disk, plus spot checks
against the live site.
Test plan:
.info.mdxAPI pages) spot-checkedagainst https://docs.turbodocx.com with
curl -o /dev/null -w '%{http_code}'