Skip to content

PRDCT-560: devdocs link cleanup — reviewer nits 1–3 (#1027 chain review) - #1036

Closed
Iamfle4ka wants to merge 1 commit into
PRDCT-554-variables-api-batchfrom
PRDCT-560-devdocs-link-cleanup
Closed

Iamfle4ka wants to merge 1 commit into
PRDCT-554-variables-api-batchfrom
PRDCT-560-devdocs-link-cleanup

Conversation

@Iamfle4ka

Copy link
Copy Markdown
Collaborator

Linear: PRDCT-560
Addresses nits 1–3 from Jordan's chain review on #1027 (thread a6426e0a). Stacked on #1033's branch (PRDCT-554-variables-api-batch) — merge last, after the rest of the stack. One commit, content-only (28 files, +82/−83).

Counts below are as measured at stack top 85897b8d; they drift from the review's numbers (~6/9/26) because branches moved since.

a) 19 developers.keboola.com links → in-repo relative paths

13 mechanical flips per the migration script's REMAP tables (canonical slugs used directly, e.g. /extend/component/running/… not /extend/docker/running/…, since redirects drop #anchors), plus judgment rewrites:

Where Why not mechanical What was done
components/extractors/database/index.md remap target is the page itself (#1019 fold) deleted the sentence; the following line already carries the point
tutorial/index.md /#development-project anchor doesn't exist on the woven home → /extend/component/tutorial/
components/applications/index.md #technical-differences doesn't exist on extend/component/ reworded bullet → /extend/component/#component-types
ai/ai-kit/index.md dev-home link is meaningless post-weave bullet retitled "Extending Keboola" → /extend/
storage/data-streams/data-streams.md (×4) all remap to the page itself (#1023 weave) 3 redundant "Learn more" links deleted; Technical Documentation section now links the Stream API docs
overview/index.md:161 dev anchor #regions-and-endpoints doesn't exist → /overview/api/#stacks-and-endpoints

All 6 rewritten anchors verified present in built HTML.

b) 9 pre-move /integrate/storage* body links → canonical

Mechanical → /storage/api/ (+ /storage/api/configurations/ for the raw <a href> in transformations/index.md). Judgment: two client links drop their anchors (/storage/api/ has no headings — a future /storage/api/clients/ page is noted in PRDCT-560); storage/api/index.md:25 would self-link, so it was de-linked instead. No /integrate/variables body links exist — only redirect_from frontmatter, untouched.

c) 24 absolute https://help.keboola.com links → relative

Pure domain strips, ](https://help.keboola.com/…) form only.

Intentionally untouched

  • index.md:32,40, 404.md:16,17 — editorial references to the dev site itself (tracked in PRDCT-560)
  • storage/api/import-export/index.md:36 — made-up example path
  • 4 help.keboola.com literals (prose examples ×3, JSON documentationUrl ×1)
  • all redirect_from: frontmatter

Nit 4 (edge-level 301s for retired developers.keboola.com) is out-of-repo — tracked as a follow-up in PRDCT-560.

Verification

  • npm run build clean; scripts/audit-phase2.mjs total issues 56 → 13 vs baseline on the same branch (no new findings; remaining old-docs smells = the 3 intentional dev-site references)
  • Grep gates: dev-domain 19→3 (intentional), pre-move body links →0 (+1 example), absolute help links 24→0 (4 literals remain)
  • Every rewritten path resolves to a real page/slug; all 6 anchors verified in dist/

🤖 Generated with Claude Code

…nical relative paths

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@linear-code

linear-code Bot commented Jul 21, 2026

Copy link
Copy Markdown

PRDCT-560

@vercel

vercel Bot commented Jul 21, 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 21, 2026 11:54am

Request Review

@keboola-pr-reviewer-bot keboola-pr-reviewer-bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verdict: needs_human (risk 2/5) · profile docs

Needs human: a clean internal-link migration where every in-repo target and anchor I checked resolves, but substantive rewrites exceed the auto-approve bucket.

Concerns:

  • src/content/docs/storage/data-streams/data-streams.md: New *.keboola.com link added (stream.keboola.com); skill §5 flags cross-domain additions for human check.
  • src/content/docs/storage/api/importer/index.md: Client links redirected to /storage/api/ with anchors dropped; target lacks clients-specific section.
  • src/content/docs/components/extractors/database/index.md: Substantive edits (reworded bullets, deleted SSH-tunnel sentence) exceed the narrow auto-approve bucket.

Suggested reviewers: @keboola/docs

@Iamfle4ka Iamfle4ka added the dev-docs-migration developers.keboola.com → help.keboola.com migration label Jul 21, 2026
@Iamfle4ka

Copy link
Copy Markdown
Collaborator Author

Closing with the rest of the #1027 chain per the 2026-07-30 decision — its base (PRDCT-554-variables-api-batch) is part of the now-closed stack, so this can never merge as-is.

Not fully obsolete, though — flagging for salvage. These are link/anchor fixes, and 24 of the 28 files it touches exist on main today as native help pages, independent of the migration:

404.md · ai/ai-kit · components/applications · components/extractors/database/{index,mysql,postgresql,azure-storage-table} · components/index · data-apps/streamlit · external-integrations/n8n · index · management/project/tokens · overview/index · storage/{index,data-streams/data-streams,data-streams/opentelemetry} · transformations/{index,python-plain,r-plain} · tutorial/{index,onboarding/index,onboarding/cheat-sheet,onboarding/usage-blueprint} · workspace/sql-editor

The remaining 4 (integrate/index, overview/api/index, storage/api/{index,importer}) target slugs that do not exist on main and should not be revived.

Follow-up: re-cut the 24 salvageable hunks as a small link-fix PR off main. Branch stays cherry-pickable: PRDCT-560-devdocs-link-cleanup.

@Iamfle4ka Iamfle4ka closed this Aug 3, 2026

This branch was successfully deployed

1 active deployment
Preview — f2fe40ed Deployed Jul 21, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dev-docs-migration developers.keboola.com → help.keboola.com migration

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants