Skip to content

PRDCT-693: put Apps prerequisites in the shared Before you start box - #1147

Merged
Iamfle4ka merged 11 commits into
mainfrom
PRDCT-693-apps-prereqs-box
Oct 1, 2026
Merged

Iamfle4ka merged 11 commits into
mainfrom
PRDCT-693-apps-prereqs-box

Conversation

@Iamfle4ka

@Iamfle4ka Iamfle4ka commented Sep 29, 2026 •

Copy link
Copy Markdown
Collaborator

Linear: PRDCT-693 · targets main since #1146 landed · also carries #1149, merged into this branch on 30 September

For the reviewer

The review bot escalated this PR because it changes site code, and its policy always sends that to a person. It asks a person to check three things:

  • The markdown twin, the inPrereqs and inStrip branches in src/integrations/page-markdown.mjs. Compare build-locally with its twin, and authentication with its twin. The box and the strips should come out as plain lists.
  • The CSS, the .prereqs* and .stage-strip* blocks in src/styles/custom.css. Look at the same pages in light and dark and on a phone. The strip turns vertical when the content column is narrower than 36rem.
  • The Open app dialog. I saw it on europe-west3 on 29 September, and nobody has checked us-east4 yet, so a VERIFY(Nikita) marks it.

Why

Nikita asked for one look for prerequisites across the docs. Getting Started shows them in a box ("BEFORE YOU START / You need"). The Apps pages used five other forms: an H2 "Before you start", an H2 "What you'll need", an H3 "Prerequisites", and an inline "Before you start." or "Before you start —" inside tabs.

What changed

  • The box from the Getting Started branch (PRDCT-487: Getting Started rerun on a Free Plan project, with a course-style hub and a 10-second clip #1144) is now a shared component: src/components/Prereqs.astro for the markup, src/components/prereqs.mjs for the wording, .prereqs* in custom.css for the styles.
    • It keeps the Getting Started API: needs, tabs, and the prompt/ui/cli slots.
    • It adds id, for a page that links to the box, and groupLabel, for a second list whose items are <li slot="group">. The label can't be called group: in MDX a named slot arrives as a prop of the same name and would overwrite it.
    • A new shared item, kai, reuses the wording of the Getting Started Prompt-tab line, checked against kai/getting-started: Kai is the Kai Agent button on supported stacks, and an organization admin switches it on the first time. Both now come from one constant.
    • projectWithKai is the Kai page's project line ("on a stack where Kai is available", no sign-up link), so that page lists the project before Kai.
  • The markdown twin (page-markdown.mjs) prints the box as text, ported from PRDCT-487: Getting Started rerun on a Free Plan project, with a course-style hub and a 10-second clip #1144, including the second list. Like PRDCT-487: Getting Started rerun on a Free Plan project, with a course-style hub and a 10-second clip #1144's version, it reads the component's props from the opening tag's line, so that tag stays on one line; the component says so in its header. MDX comments inside the box or a strip are dropped from the twin, because a markdown list can't hold them.
  • Eight blocks on five Apps pages use the box:
    • build-locally: "You need", then "Depending on how you build" (with an AI agent, by hand). #before-you-start still works. The kbagent setup step in the Cursor, VS Code and ChatGPT app tabs and in From a terminal now links "your stack URL" to the box, as the Claude Code tab already did.
    • authentication: one box in each provider tab.
    • getting-started (Kai), streamlit, streamlit/migrate-to-python-js: renamed from .md to .mdx, because components need MDX. The slugs are unchanged.
  • Additions from the reviews:
    • the Kai page links the sample opportunity.csv for readers with no data;
    • the Streamlit box names the Keboola project;
    • the Entra item says "role".
  • The box isn't a heading. The four pages that had a "Before you start", "What you'll need" or "Prerequisites" heading lose that table-of-contents entry.
  • Fixed on the way: the Auth0 troubleshooting row wrote {URL} in MDX, which evaluated it, so help.keboola.com shows the source of Node's URL class in that bullet. It's a code span now, which MDX leaves alone. The same one-line fix goes to main on its own in PRDCT-692: stop MDX printing JavaScript in the Auth0 troubleshooting row #1148, so it reaches the site sooner.
  • The shared "A Keboola project" item links the Free Plan sign-up, because /getting-started/project/ isn't on main yet. Only build-locally uses it, as before. A VERIFY(Jordan) next to the box asks whether the Free Plan includes apps, which DECISIONS.md on the Getting Started branch lists as open.

Also in this PR: #1149

#1149 was merged into this branch, so this PR also carries it. Its description has the detail and the checks.

  • src/components/StageStrip.astro, .stage-strip* in custom.css and the twin code draw numbered stages on a line. build-locally gets two strips, one under the intro of "With an AI agent" and one under "By hand".
  • A screenshot of the Open app dialog, public/data-apps/open-app-dialog.png, sits under Check the app.
  • The password location, checked on the product on 29 September: Open App opens a dialog with the app address and the password. Since PRDCT-693: merge Build with an AI agent into Build an app locally #1146 landed, help.keboola.com puts the password "next to Open App" twice on build-locally, and authentication, troubleshooting and the Kai getting-started page each have one wrong line about where it is. This PR fixes all five, and reference adds the dialog to its Open App line.
  • VERIFY notes, for things nobody has checked yet:
    • Michal Ševčík: the Edit with Kai and Duplicate with Kai labels on operate and publish-and-share.
    • Nikita: the dialog on a sleeping app, where a draft's password shows, and the dialog labels on us-east4.

Checks

  • The build is clean. check-cli-reference has 0 findings, audit-phase2 0 broken links and 0 missing images, and docs-link-redirect-check against PRDCT-693: merge Build with an AI agent into Build an app locally #1146 0 blockers and 0 warnings. Every anchor that points at these pages resolves.
  • On 30 September I merged PRDCT-693: merge Build with an AI agent into Build an app locally #1146's review fixes into this branch, then main (03e148b), which adds PRDCT-694: split DataApps time credits into Python/JS and Streamlit rates #1145. The diff against main didn't change. The build is clean again, the gates are at 0, and docs-link-redirect-check against main has 0 blockers and 0 warnings.
  • The twins print each box as text, with no <Prereqs, <li or slot= left.
  • Preview: build-locally in light, in dark and at 375 px; the other four pages in light, authentication on its Google tab. Dark mode was also checked on authentication and migrate. At 375 px all eight boxes are 343 px wide and nothing in them overflows. build-locally and the Kai page already scroll sideways at 375 px on PRDCT-693: merge Build with an AI agent into Build an app locally #1146's branch, because of other elements, and the boxes don't add to it. #before-you-start lands on the box below the header.
  • fact-checker found nothing critical. The admin-rights scope and an autolinked stack URL are fixed, and the Free Plan question is flagged.
  • guide-tester found no blockers; its fixes are listed above.
  • Miro's review (30 September) found a twin bug, where a comment inside the box moved the next item into the wrong list or into the next strip, plus two nits. All three are fixed in 5307615, which leaves the five pages' twins unchanged apart from the Kai page's new order. fact-checker and guide-tester passed it.
  • checker: FIX on the first pass (the preview claims and the counts in this description were wrong), PASS on the second, with all eight boxes re-measured at 375 px in light and dark.

Merge order and follow-up

🤖 Generated with Claude Code

The Getting Started box (#1144) becomes a shared component,
src/components/Prereqs.astro with its wording in prereqs.mjs and its
styles as .prereqs in custom.css, and the markdown twin prints it as
text. It gains an id prop, a second list (groupLabel plus
<li slot="group">) and a shared kai item.

Eight prerequisites blocks on five Apps pages move into it: build-locally
(two groups, #before-you-start kept), the four authentication tabs,
getting-started, streamlit and streamlit/migrate-to-python-js. The last
three become .mdx with unchanged slugs.

Also puts {URL} in the Auth0 troubleshooting row in a code span. MDX
evaluated it and printed the source of Node's URL class.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Sep 29, 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 Oct 1, 2026 5:12pm UTC

Request Review

@linear-code

linear-code Bot commented Sep 29, 2026

Copy link
Copy Markdown

PRDCT-693

…p dialog

A shared StageStrip component draws numbered dots on a line, the Getting
Started hub look, with a bold title and one line per stage. It is
horizontal in a wide column and vertical in a narrow one, and the
markdown twin prints it as a numbered list. build-locally gets one strip
per path.

The password is in the dialog that Open App opens, not next to Open App.
That was checked on a running test app in project 264.
build-locally, getting-started, authentication, troubleshooting and
reference are corrected, and a screenshot of the dialog goes under
Check the app.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ps-prereqs-box

The base replaced the Before you start list's data line with "A table in
Storage with the data you want the app to show" and moved What you get
by default below Check the app. The box keeps its layout and takes the
new wording; the moved section merged on its own.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…-693-apps-stage-strip

The base moved What you get by default below Check the app and stopped
repeating the password location there. The agent strip stays under the
section intro, now above Set up your client. The moved section keeps
the base's text, and the password evidence note moves to Check the app,
where the password step and the dialog screenshot are.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Base automatically changed from PRDCT-693-merge-build-locally to main September 30, 2026 13:33
Nikita and others added 2 commits September 30, 2026 15:45
The merge dropped the old defaults paragraph, and with it the sentence
behind the agent strip's fourth stage. The password bullet now has it.

The evidence comment also gets a VERIFY(Nikita): the dialog was seen on
europe-west3 only, and the UI bundles read between 22 and 29 Sep still
had an older App Credentials modal, so its labels need a look on
us-east4.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
PRDCT-693: show the Build locally stages as a strip, with the Open app dialog
#1146 landed on main and GitHub moved this PR onto it. Main also has
#1145 (the Apps pricing split), which touches reference.md and index.md
in other lines. Merged cleanly; the PR's diff against main is unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@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 4/5) · profile connection-docs

Escalating: the PR changes build/site tooling (src/integrations/page-markdown.mjs, src/styles/custom.css) and adds new components, so it is not a content-bucket PR.

Concerns:

  • src/integrations/page-markdown.mjs: Build tooling changed; new twin slot-parsing regex needs human review against preview.
  • src/styles/custom.css: ~140 lines of new component CSS; visual output not machine-verifiable.
  • src/content/docs/data-apps/build-locally.mdx: Open-App password dialog may not be deployed on us-east4 yet (VERIFY notes).

Suggested reviewers: @keboola/docs

@MiroCillik MiroCillik left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One twin bug and two nits, inline.

  • the preview looks right: build-locally at 1280, 1000 and 375 px in light and dark, and authentication at 375 px in dark. No box or strip is wider than its column, and the strip turns vertical at 375 px
  • the twins of all five pages print the boxes and strips as plain lists, with no <Prereqs, <li or slot= left
  • the removed headings' anchors (#what-youll-need, #prerequisites, migrate's #before-you-start) have no inbound links under src/
  • I did not check the Open App dialog on us-east4; the VERIFY(Nikita) is still open

Comment thread src/integrations/page-markdown.mjs
Comment thread src/content/docs/data-apps/getting-started.mdx Outdated
Comment thread src/components/prereqs.mjs Outdated
@MiroCillik

Copy link
Copy Markdown
Member

BTW, why check Open app dialog on us-east4 specifically? :)

Miro's review of #1147. In the markdown twin, an MDX comment inside
<Prereqs> or <StageStrip> was glued onto the next item: a group item
after it landed in "You need", and a comment on the box's last line
leaked into the first stage of the next strip. Comments inside those
two lists are now dropped, and the buffer is cleared at both closing
tags. No page has such a comment today, and the five pages' twins are
unchanged.

The Kai page's box now lists the project before Kai, from a new shared
item, projectWithKai, with the same wording.

The comments in the new files now give the reason for the code rather
than its history: no dated quote, no Cloudflare numbers or page counts,
no pointers at PR #1144. The TODO about /getting-started/project/ stays.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… note

The note said UI bundles "read between 22 and 29 Sep" still had the old
modal. Those were older builds (Last-Modified 25 Aug and 14 Sep); only
the logs that named them were from that week. Nothing shows a stack
serving the old modal now, so the note says what is known: the dialog
was seen on europe-west3, and only a logged-in page shows which build
a stack loads.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
GitHub reported a conflict after #1151 and #1152 landed. A fresh
merge of main resolved on its own: main's only change to
page-markdown.mjs is the llms.txt header line ("apps"), and
reference.md keeps #1151's Apps rates and sizes links next to this
branch's Open App dialog line.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@MiroCillik MiroCillik left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

All findings fixed in 5307615. The us-east4 Open App dialog VERIFY(Nikita) is still open.

@Iamfle4ka
Iamfle4ka merged commit 8a96fb8 into main Oct 1, 2026
3 checks passed
@Iamfle4ka
Iamfle4ka deleted the PRDCT-693-apps-prereqs-box branch October 1, 2026 17:20

This branch was successfully deployed

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

Labels

agent-needs-human agent-profile:connection-docs apps-ga Apps GA on 1 Oct 2026 — docs work tracked under AJDA-3380

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants