Skip to content

PRDCT-480: fix broken links, dead anchors, invalid JSON examples, and typos across the docs - #402

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

PRDCT-480: fix broken links, dead anchors, invalid JSON examples, and typos across the docs#402
claude[bot] wants to merge 4 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: A documentation audit turned up a batch of small but real defects scattered across the developer docs — links that pointed to the wrong page or a non-existent anchor, a couple of code samples with invalid JSON that would fail if copy-pasted, some root-relative links that silently pointed off-site, and a handful of plain typos.

After: Every one of those verified issues is corrected. Internal links now resolve to real headings, cross-site links go to the correct help.keboola.com pages, the JSON examples parse, and the typos are gone. No content was rewritten — these are surgical, mechanical corrections only.

How

Each candidate fix from the audit was independently re-verified against the checked-out repos before editing: for anchor fixes the target heading's kramdown slug was confirmed; for cross-site links the target page's existence was confirmed in the connection-docs repo (which serves help.keboola.com); for JSON fixes the surrounding code block was read and the minimal change applied; for typos the misspelling was confirmed literally present. Two headings were renamed (rather than editing many inbound links) because more inbound links matched the new wording than the old.

Applied fixes

File : line Problem Change
extend/generic-extractor/configuration/config/index.md:64 anchor #dataType doesn't match heading #data-type
extend/generic-extractor/tutorial/basic.md:18 anchor #configuration-sections missing #json-configuration-sections
extend/generic-extractor/configuration/api/pagination/index.md:121 offset link pointed at pagenum page .../pagination/offset/
extend/generic-extractor/tutorial/basic.md:195 invalid JSON — missing comma after api object added ,
extend/generic-extractor/functions.md:46 invalid JSON — unterminated string closed "http://example.com/"
extend/component/running/index.md:96 heading ## Preparing Data folder broke 6 inbound links ## Preparing the Data folder
extend/component/running/index.md:202 heading ## Running Component broke 2 inbound links ## Running a Component
extend/component/running/index.md:23 typo "you loose" "you lose"
extend/common-interface/folders.md:159-160 link URL split across a newline joined into one line
extend/common-interface/folders.md:200 cross-site links /storage/tables/, /storage/file-uploads/ https://help.keboola.com/storage/tables/, https://help.keboola.com/storage/files/
extend/common-interface/folders.md:220 link missing leading slash /extend/common-interface/folders/#root-folder-data
extend/common-interface/folders.md:232-234,242 typo my-inpupt my-input
extend/generic-writer/index.md:38 typo "encripted" + missing slash [encrypted parameters](/overview/encryption/)
extend/generic-writer/configuration/configuration.md:43 anchor #enpoint-path #endpoint-path
extend/common-interface/config-file.md:253 typo "colummns" "columns"
extend/common-interface/config-file.md:261 invalid JSON — missing comma after destination added ,
cli/index.md:25-27 empty targets [Example Use Cases]() (×3) /cli/devops-use-cases/
cli/commands/index.md:67 kbc remote workspace row pointed at remote/create/ /cli/commands/remote/workspace/
cli/commands/remote/index.md:34 same mis-target /cli/commands/remote/workspace/
cli/commands/local/create/config/index.md:71 typo brabch in link /cli/commands/remote/create/branch/
cli/commands/local/create/row/index.md:65 typo brabch in link /cli/commands/remote/create/branch/
cli/structure/index.md:84 cross-site link /components/branches/ https://help.keboola.com/components/branches/
cli/commands/sync/diff/index.md:31 cross-site link /components/extractors/storage/google-drive/ https://help.keboola.com/components/extractors/storage/google-drive/
integrate/variables/index.md:237 singular anchor #...-for-variable doesn't match heading /integrate/variables/#step-2--create-default-values-for-variables
integrate/variables/index.md:382 hardcoded localhost:4000 URL + singular anchor /integrate/variables/#step-2--create-default-values-for-variables
integrate/jobs/index.md:213 placeholder [job types](todo) /integrate/jobs/#job-type
integrate/mcp.md:101 cross-site link /ai/mcp-server/ https://help.keboola.com/ai/mcp-server/
integrate/mcp.md:282 cross-site link /management/project/ https://help.keboola.com/management/project/
overview/index.md:62 link to deleted page /integrate/transformations/ https://help.keboola.com/transformations/
extend/common-interface/development-branches.md:21 typo "accross" "across"

Skipped / needs review

  • All "Needs judgment" audit items were intentionally left out of this PR (stale version numbers, past-dated deprecation notices, discontinued third-party APIs, swapped auth sections, apiary.io legacy API hosts, etc.). They require an SME/product decision rather than a mechanical edit.

🤖 Generated with Claude Code

https://claude.ai/code/session_0195QR1C2VEmAX7rxsKJZxhF

@claude
claude Bot force-pushed the claude/docs-audit-fixes branch from 267d72b to b991995 Compare July 20, 2026 09:10
@Iamfle4ka Iamfle4ka changed the title Fix broken links, dead anchors, invalid JSON examples, and typos across the docs PRDCT-480: fix broken links, dead anchors, invalid JSON examples, and typos across the docs Aug 3, 2026
@linear-code

linear-code Bot commented Aug 3, 2026

Copy link
Copy Markdown

PRDCT-480

Resolves 10 conflicts. Every one is on a page main has since turned into a
redirect_to stub (#405/#406/#412/#413), so the fix queued for it is invisible
to readers of this site; main's stub wins in each case:

  extend/common-interface/config-file.md            "colummns"; missing , after destination
  extend/common-interface/development-branches.md   "accross" -> "across"
  extend/common-interface/folders.md                URL split across a newline; missing leading /; "my-inpupt"
  extend/component/running/index.md                 "you loose"; 2 heading renames for inbound links
  .../generic-extractor/.../api/pagination/index.md offset link pointed at the pagenum page
  .../generic-extractor/configuration/config/index.md  #dataType -> #data-type
  extend/generic-extractor/functions.md             unterminated "http://example.com/ string
  extend/generic-extractor/tutorial/basic.md        #configuration-sections anchor; missing , in JSON
  integrate/mcp.md                                  2 root-relative links that pointed off-site
  integrate/variables/index.md                      singular #...-for-variable anchor; localhost:4000 URL

Those belong against help now, alongside connection-docs#1077 — listed above
so they are not lost. The 11 surviving fixes (/cli/, /integrate/jobs/,
/overview/, /extend/generic-writer/) are untouched.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Wc7aH2VDs4qYwxCai1JuSA
Iamfle4ka pushed a commit that referenced this pull request Aug 26, 2026
Both pages stay on this site and this PR only rewrites 6 Storage links in
them, but they were also normalised CRLF -> LF, which rewrote every line:
351 changed lines instead of 6. That buried the real change in review and
made both files collide with every other open PR that touches them (#410,
#402), since no line merged cleanly.

Content is byte-identical to the previous commit — line endings only, back
to what main has. The 8 integrate/storage/** files are left alone: they
become redirect stubs here, so their whole content is replaced regardless.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Wc7aH2VDs4qYwxCai1JuSA
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