Change type
Standard — low-risk, pre-approved
Risk / impact
Low
Security impact assessed?
No — no security impact
Details — description & full context
Correction: The broken-link checker that produced this CR resolved Docusaurus
file-relative links (e.g. ./setting-up-automation.md, ../../TurboSign/Webhooks.md)
against the site root instead of against the linking file's own directory. That made it
misreport a large number of working links as broken, so the original "56 broken links"
count was inflated. Verified on the live site: docs/Integrations/Wrike/index.md's
./setting-up-automation.md correctly renders as
https://docs.turbodocx.com/docs/Integrations/Wrike/setting-up-automation (200).
The linked PR was reworked to (1) revert the 25 files where the checker's report was a
false positive back to their original relative links, and (2) keep only the genuine
fixes:
- Webhook Integration / Webhook Configuration (in
API Templates.md and
ai-variable-generation.md) pointed at /docs/Webhooks/webhook-configuration, which
does not exist. Repointed to the real webhooks page: /docs/TurboSign/Webhooks.
- API Authentication (same two files) had been pointed at
/docs/API/Deliverable%20API by the first pass of this CR. Its original target,
/docs/API/turbodocx-api-documentation, actually resolves (confirmed 200 live), so it
was reverted to that.
- Bulk Document Generation / Bulk Processing, Template Version Management, and
Template Management Guide pointed at pages that don't exist anywhere in the docs
site (/docs/Templates/*). No existing page covers this content, so these bullets
were removed outright rather than replaced with a "(coming soon)" placeholder, which
would publicly promise a feature/doc that may never ship.
- Integration Examples pointed at
/docs/Integrations. That category page is
configured as a Docusaurus generated-index, but it actually 404s on the live site,
so this is a genuine (if minor) site issue outside this CR's scope; the dead bullet
was removed rather than left linking to a 404.
Net result: 3 files changed (down from 28), removing 2 lines and fixing 2 bullets to
point at real pages. git diff origin/develop...HEAD now shows only these real fixes.
Component / area
Documentation — internal cross-linking
Testing & validation
Rollback plan
Revert the merge commit to restore the previous (checker-driven) link state.
Breaking change for consumers?
No
Reviewer / approver
@me
Change type
Standard — low-risk, pre-approved
Risk / impact
Low
Security impact assessed?
No — no security impact
Details — description & full context
Correction: The broken-link checker that produced this CR resolved Docusaurus
file-relative links (e.g.
./setting-up-automation.md,../../TurboSign/Webhooks.md)against the site root instead of against the linking file's own directory. That made it
misreport a large number of working links as broken, so the original "56 broken links"
count was inflated. Verified on the live site:
docs/Integrations/Wrike/index.md's./setting-up-automation.mdcorrectly renders ashttps://docs.turbodocx.com/docs/Integrations/Wrike/setting-up-automation(200).The linked PR was reworked to (1) revert the 25 files where the checker's report was a
false positive back to their original relative links, and (2) keep only the genuine
fixes:
API Templates.mdandai-variable-generation.md) pointed at/docs/Webhooks/webhook-configuration, whichdoes not exist. Repointed to the real webhooks page:
/docs/TurboSign/Webhooks./docs/API/Deliverable%20APIby the first pass of this CR. Its original target,/docs/API/turbodocx-api-documentation, actually resolves (confirmed 200 live), so itwas reverted to that.
Template Management Guide pointed at pages that don't exist anywhere in the docs
site (
/docs/Templates/*). No existing page covers this content, so these bulletswere removed outright rather than replaced with a "(coming soon)" placeholder, which
would publicly promise a feature/doc that may never ship.
/docs/Integrations. That category page isconfigured as a Docusaurus
generated-index, but it actually 404s on the live site,so this is a genuine (if minor) site issue outside this CR's scope; the dead bullet
was removed rather than left linking to a 404.
Net result: 3 files changed (down from 28), removing 2 lines and fixing 2 bullets to
point at real pages.
git diff origin/develop...HEADnow shows only these real fixes.Component / area
Documentation — internal cross-linking
Testing & validation
the resolved relative/absolute path)
curl -o /dev/null -w '%{http_code}'(e.g./docs/TurboSign/Webhooks→ 200,/docs/Integrations→ 404,/docs/API/turbodocx-api-documentation→ 200)checker's relative-link resolution before trusting its next report)
Rollback plan
Revert the merge commit to restore the previous (checker-driven) link state.
Breaking change for consumers?
No
Reviewer / approver
@me