Conversation
…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>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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>
|
Added the sentence-case heading pass ( Anchor safety is verified, not assumed. I built the tree before and after and diffed the Left capitalised: product names (Generic Extractor, Keboola), acronyms (API, URL, JSON, OAuth, HTTP, SSH, AWS, CSV), identifiers that are names rather than prose ( Three the first pass got wrong and I corrected: "Configuration with Query parameters" and "API Query authentication" — Build clean, |
|
@keboola-pr-reviewer review |
keboola-pr-reviewer-bot
left a comment
There was a problem hiding this comment.
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.
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 referenceThe last part hands off to the reference instead of dead-ending, and the index keeps its existing
## Next Stepslist 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.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 pageand replace the note with a real source and date, instead of inheriting a claim nobody made.Verification
npm run buildclean ·audit-phase2MISSING IMAGES 0, counts unchanged frommain· all seven Next targets resolve indist/.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