Skip to content

PRDCT-676: give the Generic Extractor tutorial a reading order, and classify all 39 pages - #1115

Open
Iamfle4ka wants to merge 4 commits into
mainfrom
PRDCT-676-ge-form
Open

Iamfle4ka wants to merge 4 commits into
mainfrom
PRDCT-676-ge-form

Conversation

@Iamfle4ka

Copy link
Copy Markdown
Collaborator

Linear: PRDCT-676 · under the dev-ported Diátaxis rework epic. Form only — no page created, split, moved or deleted, no nav change, no prose rewritten.

The reading order

The Generic Extractor tutorial is a real seven-part progression built on one API, but every part ended mid-thought. Only the index carried a list of what to read; the six parts themselves just stopped. Each now ends with a Next pointer following the nav order:

index → REST → JSON → basic configuration → pagination → jobs → mapping → configuration reference

The last part hands off to the reference instead of dead-ending, and the index keeps its existing ## Next Steps list rather than being given a competing one.

Type markers

All 39 pages now carry the type marker convention already used in src/content/docs/cli/. The tree had zero.

Type Pages
tutorial the 7 tutorial pages
explanation the hub, the parameter map
how-to running, publishing, incremental, SSH proxy
reference the remaining 26

The markers deliberately carry no verification date. Nothing here was fact-checked against keboola/generic-extractor — this is a form pass — so each marker says exactly that and points at PRDCT-676. A later accuracy pass can grep -type page and replace the note with a real source and date, instead of inheriting a claim nobody made.

Verification

npm run build clean · audit-phase2 MISSING IMAGES 0, counts unchanged from main · all seven Next targets resolve in dist/.

Anchor count reads 23 in this branch because it is cut from main; those are the pre-existing breakages fixed separately in #1112, not a regression here.

Not in this PR

Sentence-case headings (a large mechanical diff across all 39 pages, better on its own), and everything structural — the cookbook extraction and the auth/pagination folds are gated on an owner decision in PRDCT-674.

🤖 Generated with Claude Code

…lassify all 39 pages

The tutorial is a real seven-part progression built on one API, but every part
ended mid-thought: nothing told the reader where to go next, and only the index
carried a list. Each part now ends with a Next pointer following the nav order —
REST → JSON → basic configuration → pagination → jobs → mapping — and the last
one hands off to the configuration reference rather than dead-ending. The index
keeps its existing Next Steps list.

Every one of the 39 pages also gets a type marker, the convention already used
in src/content/docs/cli/. The tree had none. Types: tutorial for the seven
tutorial pages, explanation for the hub and the parameter map, how-to for
running, publishing, incremental and the SSH proxy, reference for the rest.

The markers deliberately do NOT claim a verification date. Nothing here was
fact-checked against keboola/generic-extractor — this is a form pass — so each
marker says so and points at PRDCT-676. A later accuracy pass can grep for them
and replace the note with a real source and date.

Form only: no page created, split, moved or deleted, no nav change, no prose
rewritten.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@Iamfle4ka Iamfle4ka added the dev-docs-migration developers.keboola.com → help.keboola.com migration label Sep 2, 2026
@linear-code

linear-code Bot commented Sep 2, 2026

Copy link
Copy Markdown

PRDCT-676

@vercel

vercel Bot commented Sep 2, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
connection-docs Ready Ready Preview Sep 30, 2026 1:55pm UTC

Request Review

House style is sentence case; this tree was Title Case throughout, inherited
from the dev-docs original. 176 headings across 33 pages.

Case-only, and verified to be so: the built anchor ids are byte-identical
before and after — 476 ids, none added, none removed — because Starlight
slugifies through github-slugger, which lowercases anyway. No link, in this
repo or in the keboola org, can break on this.

Left capitalised: product names (Generic Extractor, Keboola), acronyms (API,
URL, JSON, OAuth, HTTP, SSH, AWS, CSV), scroller and function names that are
identifiers rather than prose (Has-More, StrToTime), and the first word after
a step number.

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

Copy link
Copy Markdown
Collaborator Author

Added the sentence-case heading pass (1896028c) — 176 headings across 33 pages. It was listed as "not in this PR" above; it turned out small and provably safe, so it belongs here rather than in a seventh PR.

Anchor safety is verified, not assumed. I built the tree before and after and diffed the id="…" attributes: 476 ids before, 476 after, none added, none removed. Starlight slugifies through github-slugger, which lowercases, so ## Data Type and ## Data type both render data-type. Nothing that links into this tree — in this repo or in the keboola org — can break on it.

Left capitalised: product names (Generic Extractor, Keboola), acronyms (API, URL, JSON, OAuth, HTTP, SSH, AWS, CSV), identifiers that are names rather than prose (Has-More, StrToTime), and the first word after a step number.

Three the first pass got wrong and I corrected: "Configuration with Query parameters" and "API Query authentication" — Query was on my keep-list for the auth method name and leaked into common-noun use — and "encrypted Token example".

Build clean, audit-phase2 MISSING IMAGES 0 and totals unchanged from this branch's baseline.

keboola-pr-reviewer-bot

This comment was marked as outdated.

@Iamfle4ka

Copy link
Copy Markdown
Collaborator Author

@keboola-pr-reviewer 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: auto_approve (risk 2/5) · profile connection-docs

Auto-approve: a content-bucket form pass (heading sentence-casing, Next pointers, type-marker comments) with no URL breakage.

This branch was successfully deployed

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants