PRDCT-548: fix broken links, dead anchors, and typos across the docs - #1014
Draft
claude[bot] wants to merge 3 commits into
Draft
PRDCT-548: fix broken links, dead anchors, and typos across the docs#1014claude[bot] wants to merge 3 commits into
claude[bot] wants to merge 3 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
claude
Bot
force-pushed
the
claude/docs-audit-fixes
branch
from
July 20, 2026 09:14
4f9e89a to
81c8f62
Compare
claude
Bot
force-pushed
the
claude/docs-audit-fixes
branch
from
July 27, 2026 09:19
81c8f62 to
ed59bc5
Compare
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.
claude
Bot
force-pushed
the
claude/docs-audit-fixes
branch
from
July 27, 2026 13:24
ed59bc5 to
c00fb58
Compare
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
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.
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 incorrectrowspanand 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
components/extractors/database/index.md:58/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)/kai/(both)components/extractors/database/mysql/index.md:13#log-based-binlog-cdc(no such heading)/components/extractors/database/mysql/#mysql-log-based-cdccomponents/extractors/database/postgresql/index.md:13#log-based-cdc(no such heading)#postgresql-log-based-cdccomponents/extractors/database/bigquery/index.md:18#using-bigquery-extractor/tutorial/ad-hoc/#using-bigquery-connectorcomponents/writers/bi-tools/tableau/index.md:17#using-keboola-provisioned-databasenot on Snowflake page/components/writers/database/snowflake/#using-keboola-snowflake-databasecomponents/running-jobs-in-parallel/index.md:45#project-power/management/project/limits/#project-power---time-creditsmanagement/jobs/index.md:17#project-power/management/project/limits/#project-power---time-creditstransformations/index.md:112rowspan='7'but 8 rowsrowspan='8'transformations/index.md:174-181<td>✓</td><td>Not available</td>,rowspan='9')rowspan='8'storage/tables/data-types/index.md:119/transformations/#read-only-input-mapping/transformations/mappings/#read-only-input-mappingmanagement/notifications/notifications.md:21management/notifications/notifications.md:36. ---management/support/index.md:21,58#who-can-access-a-project#who-can-access-projectmanagement/organization/index.md:93#who-can-access-a-project#who-can-access-projectmanagement/project/tokens/index.md:120#sharing-a-token#sharing-tokenmanagement/project/tokens/index.md:58#refreshing-a-token#refreshing-tokenmanagement/project/tokens/index.md:33#removing-a-user/management/project/users/#removing-usermanagement/account/index.md:139#inviting-a-user/management/project/users/#inviting-userworkspace/index.md:134private_key_etncrypted.pemprivate_key_encrypted.pemworkspace/index.md:303workspace/sql-editor/index.md:128tutorial/manipulate/index.md:34/transformations/#output-mapping(no such heading)/transformations/mappings/#output-mappingtutorial/branches/project-diff.md:36#extend-the-transformation#extend-transformationtutorial/ad-hoc/index.md:39#manually-loading-data/tutorial/load/#manual-data-loadingtutorial/manipulate/workspace.md:49[previous tutorial step])/tutorial/manipulate/).[previous tutorial step](/tutorial/manipulate/).tutorial/onboarding/architecture-guide/index.md:57tutorial/branches/tables-in-branch.md:113bitcoin_prices(canonical name isbitcoin_price, used 10×)bitcoin_pricecatalog/index.md:121#sharing-type(heading is "Sharing Types")#sharing-typescatalog/index.md:41#multi-project-architecture(no such heading)/catalog/multi-project/overview/index.md:122[Flows](/tutorial/automate/#main-header)components/writers/other/yourpass/index.md:120"dynamicData_fistName"value,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:
management/global-search/index.mdscreenshot references (global-search-matched-column.png,global-search-regex.png) on the assumption they were missing. On re-verification againstmainboth files do exist inpublic/management/global-search/and are validly referenced (the same page uses the identical root-relative pattern forglobal-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:122anchor: the fix preserves the original#main-headeranchor, 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 onmainin the Apps restructure, so the typo fix no longer applies.kai/python-client.md:103(#secretsanchor):mainalready fixed this link to the canonical/data-apps/reference/#secrets(the/data-apps/python-js/page proposed here no longer exists). Tookmain's version.data-apps/general-design-guide/index.md:38(stray"in path literal): the page was renamed todata-apps/streamlit/design-guide.mdonmainand already contains the correct'static/keboola.png'literal, so the fix is redundant. Tookmain's version.🤖 Generated with Claude Code
https://claude.ai/code/session_0195QR1C2VEmAX7rxsKJZxhF
Generated by Claude Code