Skip to content

PRDCT-548: fix broken links, dead anchors, and typos across the docs - #1014

Draft
claude[bot] wants to merge 3 commits into
mainfrom
claude/docs-audit-fixes
Draft

PRDCT-548: fix broken links, dead anchors, and typos across the docs#1014
claude[bot] wants to merge 3 commits into
mainfrom
claude/docs-audit-fixes

Conversation

@claude

@claude claude Bot commented Jul 10, 2026

Copy link
Copy Markdown

Requested by Jordan Burger · Slack thread

Before / After

Before: Several documentation pages contained links that led nowhere — cross-page links whose anchors no longer matched renamed headings, links pointing at the wrong page, a couple of malformed link fragments that rendered as raw text, two <img> references to screenshots that were never committed, and a scattering of plain typos. Readers clicking these hit dead anchors (landing at the top of a page instead of the relevant section), broken pages, broken images, or simply read misspelled words. One HTML comparison table also mis-rendered because of an incorrect rowspan and a stray, malformed row.

After: Every one of those links now resolves to the correct page and section, the malformed links render as proper links, the broken image references are gone, the comparison table renders with the correct row structure, and the typos read correctly.

How

Each fix comes from an automated documentation audit and was individually verified against the repository before applying: for every anchor I confirmed the target heading exists and that its Starlight-slugified form matches the anchor; for every page link I confirmed the target file's slug/redirect_from; for every typo I confirmed the misspelling was literally present. Edits are minimal and surgical — one link/word/line per fix — with no unrelated changes. A handful of source files use mixed CRLF/LF line endings, so those edits were applied at the byte level to avoid line-ending churn in the diff.

Fixes applied

File:line What was wrong Change
components/extractors/database/index.md:58 Azure Storage Table bullet linked to the Cosmos DB page link → /components/extractors/database/azure-storage-table/
components/extractors/other/telemetry-data/telemetry-data.md:39,302 [Kai](/ai/kai-assistant/) — route does not exist (prose + diagram JSON) link → /kai/ (both)
components/extractors/database/mysql/index.md:13 anchor #log-based-binlog-cdc (no such heading) /components/extractors/database/mysql/#mysql-log-based-cdc
components/extractors/database/postgresql/index.md:13 anchor #log-based-cdc (no such heading) #postgresql-log-based-cdc
components/extractors/database/bigquery/index.md:18 stale anchor #using-bigquery-extractor /tutorial/ad-hoc/#using-bigquery-connector
components/writers/bi-tools/tableau/index.md:17 #using-keboola-provisioned-database not on Snowflake page /components/writers/database/snowflake/#using-keboola-snowflake-database
components/running-jobs-in-parallel/index.md:45 anchor #project-power /management/project/limits/#project-power---time-credits
management/jobs/index.md:17 anchor #project-power /management/project/limits/#project-power---time-credits
transformations/index.md:112 Backend category rowspan='7' but 8 rows rowspan='8'
transformations/index.md:174-181 malformed "Other features" first row (stray <td>✓</td><td>Not available</td>, rowspan='9') removed stray cells, merged into Versioning row, rowspan='8'
storage/tables/data-types/index.md:119 non-canonical /transformations/#read-only-input-mapping /transformations/mappings/#read-only-input-mapping
management/notifications/notifications.md:21 typo "glow" "flow"
management/notifications/notifications.md:36 "an flow" + stray . --- "a flow"; punctuation fixed
management/support/index.md:21,58 anchor #who-can-access-a-project #who-can-access-project
management/organization/index.md:93 anchor #who-can-access-a-project #who-can-access-project
management/project/tokens/index.md:120 anchor #sharing-a-token #sharing-token
management/project/tokens/index.md:58 anchor #refreshing-a-token #refreshing-token
management/project/tokens/index.md:33 anchor #removing-a-user /management/project/users/#removing-user
management/account/index.md:139 anchor #inviting-a-user /management/project/users/#inviting-user
workspace/index.md:134 typo private_key_etncrypted.pem private_key_encrypted.pem
workspace/index.md:303 typo "Curently" "Currently"
workspace/sql-editor/index.md:128 typo "preffered" "preferred"
tutorial/manipulate/index.md:34 /transformations/#output-mapping (no such heading) /transformations/mappings/#output-mapping
tutorial/branches/project-diff.md:36 anchor #extend-the-transformation #extend-transformation
tutorial/ad-hoc/index.md:39 anchor #manually-loading-data /tutorial/load/#manual-data-loading
tutorial/manipulate/workspace.md:49 malformed link [previous tutorial step])/tutorial/manipulate/). [previous tutorial step](/tutorial/manipulate/).
tutorial/onboarding/architecture-guide/index.md:57 stray trailing "ne" removed
tutorial/branches/tables-in-branch.md:113 typo bitcoin_prices (canonical name is bitcoin_price, used 10×) bitcoin_price
catalog/index.md:121 anchor #sharing-type (heading is "Sharing Types") #sharing-types
catalog/index.md:41 anchor #multi-project-architecture (no such heading) /catalog/multi-project/
overview/index.md:122 bracket-wrapped URL rendered as plain text [Flows](/tutorial/automate/#main-header)
components/writers/other/yourpass/index.md:120 invalid JSON — missing comma after "dynamicData_fistName" value added ,

Skipped / needs review

None from the connection-docs "clear-cut" set — every candidate was verified and applied.

Notes on two candidates that were verified but deserve a second look from a maintainer:

  • Global search images (dropped on rebase): an earlier revision of this PR removed two management/global-search/index.md screenshot references (global-search-matched-column.png, global-search-regex.png) on the assumption they were missing. On re-verification against main both files do exist in public/management/global-search/ and are validly referenced (the same page uses the identical root-relative pattern for global-search-1/2/3.png), so that removal was reverted — the two images are restored and this is no longer a fix.
  • overview/index.md:122 anchor: the fix preserves the original #main-header anchor, which is an established convention used elsewhere on this site (e.g. ai/index.md, overview/index.md:177). The primary bug fixed here is the bracket-syntax that made the link render as literal text.

Dropped on rebase onto the Apps-restructure main (PRDCT-358 / PRDCT-489)

Rebasing onto the current main (which restructured the Apps section) made three of the fixes above obsolete, so they were dropped — the branch no longer touches these files:

  • data-apps/lock-streamlit-version/git-deployment/index.md:79 ("environmnet" typo): this page was deleted on main in the Apps restructure, so the typo fix no longer applies.
  • kai/python-client.md:103 (#secrets anchor): main already fixed this link to the canonical /data-apps/reference/#secrets (the /data-apps/python-js/ page proposed here no longer exists). Took main's version.
  • data-apps/general-design-guide/index.md:38 (stray " in path literal): the page was renamed to data-apps/streamlit/design-guide.md on main and already contains the correct 'static/keboola.png' literal, so the fix is redundant. Took main's version.

🤖 Generated with Claude Code

https://claude.ai/code/session_0195QR1C2VEmAX7rxsKJZxhF


Generated by Claude Code

@vercel

vercel Bot commented Jul 10, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
connection-docs Ready Ready Preview, Comment Jul 27, 2026 1:25pm

Request Review

@Iamfle4ka Iamfle4ka changed the title Fix broken links, dead anchors, and typos across the docs PRDCT-548: fix broken links, dead anchors, and typos across the docs Jul 15, 2026
@linear-code

linear-code Bot commented Jul 15, 2026

Copy link
Copy Markdown

PRDCT-548

PRDCT-503

claude added 3 commits July 27, 2026 13:22
The two screenshots (global-search-matched-column.png and global-search-regex.png)
exist in public/ and are validly referenced; they were removed by mistake. This
reverts that removal so the images render again.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant