Skip to content

PRDCT-489: Apps section — content review + real UI screenshots - #996

Closed
Iamfle4ka wants to merge 17 commits into
mainfrom
PRDCT-358-apps-restructure
Closed

PRDCT-489: Apps section — content review + real UI screenshots#996
Iamfle4ka wants to merge 17 commits into
mainfrom
PRDCT-358-apps-restructure

Conversation

@Iamfle4ka

Copy link
Copy Markdown
Collaborator

Draft PR for the Apps (data-apps) documentation section.

What's in it

A page-by-page review of the Apps section, grounded in the live product UI where facts were needed. Screenshots are real captures of the current Keboola UI.

  • Sidebar order: What are apps? moved before the Build guides; examples renamed Beyond dashboards.
  • Consistency: one canonical Python/JS vs Streamlit framing (anchored in What are apps), consistent Python/JS label across pages.
  • Build with Kai: full topic breakdown (prompting, refining, governance) + real Kai-chat and Approve screenshots.
  • Build in the UI: rewritten to the observed create → config → deploy flow + 3 real screenshots.
  • Build locally: filled the empty Sync to project and AI coding tool sections from the live UI + Python/JS screenshots.
  • What are apps: sharpened governed by default; added a live deployed-app screenshot.
  • Python/JS: real app-config screenshot + downloadable AI-skill note.
  • Authentication: corrected to the real Authentication Type dropdown (6 methods: None, Basic, OIDC, GitLab, GitHub, JumpCloud) + fresh screenshot.
  • Reference: intro + on-page nav; lock-version illustrative-versions note; code-fence languages in Streamlit pages.
  • Cleanup: removed stale/orphan images (app-modal, unused examples-*).
  • Tooling: added project skill capturing-keboola-ui-screenshots (CDP screenshot workflow).

Still needs a maintainer (left as TODO/VERIFY in-page)

Product facts I couldn't verify from the UI alone: exact Kai-in-E2B prerequisite, the draft → production flow, hosting model (Operator vs E2B), Python/JS scaffold contents, and Publish and share flow.

Notes

  • Draft: not for merge yet — review the wording/screenshots first.
  • Two throwaway draft apps were created in a dev branch of the Documentation Analysis project (project 6015) to capture UI: Sales Dashboard (43681629) and Sales API (43681630), both Not Deployed. Safe to delete.

🤖 Generated with Claude Code

Nikita and others added 2 commits July 2, 2026 18:07
…orm)

Restructure src/content/docs/data-apps to the approved skeleton, realized
with the real old content: hub, getting-started (real Kai walkthrough
performed in project 6015 + Story of Us inspiration), examples (Jordan's
3 public picks: Seasonal, Flight Shockwave, Color Season Analyzer),
what-are-apps, build-with-kai / build-in-the-ui / build-locally,
python-js overview (framework page restored per review), authentication
(4 OIDC pages merged), publish-and-share, reference (limits at bottom),
streamlit subtree (lock-version 3->1 merge, design-guide move).

Images: docs reference /data-apps/*.png served from public/data-apps/;
grey placeholder PNGs in place, real captures via apps-section/screenshots.mjs.
Release changelog deleted (belongs in changelog). VERIFY/TODO owner flags
embedded for the accuracy stage. apps-section/ bundle: CONTEXT, STRUCTURE,
content-proposal, APPS-UPDATE-PLAN, HANDOFF-PROMPT, screenshots.mjs.

Structure+form only — facts moved verbatim, not verified. No PR yet.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…ix sidebar order

Page-by-page review of the Apps (data-apps) section, grounded in the live
product UI where facts were needed.

- Sidebar: move "What are apps?" before the Build guides; rename examples → "Beyond dashboards"
- Canonical "Python/JS vs Streamlit" framing (what-are-apps anchor); consistent "Python/JS" label
- Build with Kai: full topic breakdown (prompt/refine/governance) + real Kai chat & Approve screenshots
- Build in the UI: rewrite to observed create → config → deploy flow + 3 real screenshots
- Build locally: fill "Sync to project" and "AI coding tool" sections from live UI + Python/JS screenshots
- What are apps: sharpen "governed by default"; add a live deployed-app screenshot
- Python/JS: real app-config screenshot + downloadable AI-skill note
- Authentication: correct to the real Authentication Type dropdown (6 methods) + fresh screenshot
- Reference: lede + on-page nav; lock-version illustrative-versions note; code-fence languages
- Remove stale/orphan images (app-modal, unused examples-*)
- Add project skill: capturing-keboola-ui-screenshots (CDP screenshot workflow)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@linear-code

linear-code Bot commented Jul 7, 2026

Copy link
Copy Markdown

@vercel

vercel Bot commented Jul 7, 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 10, 2026 5:58pm

Request Review

- Publish and share: reframe to the grounded deploy → auth → share flow;
  note the dev-branch → production path; flag the ambiguous "promote to
  production" semantics for a maintainer instead of asserting it.
- Reference: flesh out the Per-app settings table from the observed app
  config (Code Source, backend version/size, auto-sleep); fix the Secrets
  error — the variable NAME is uppercased, the value is passed through unchanged.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
apps-section/ (planning, context, handoff, capture scripts) and .claude/
are local-only working files, not product docs. Untrack and gitignore them
so they don't ship in the Apps PR. Follows the repo precedent (db81d1f).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@Iamfle4ka
Iamfle4ka marked this pull request as ready for review July 8, 2026 14:39

@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 docs

Escalating: this draft restructures the whole Apps section — navigation data, sidebar, site CSS, and many page moves — all policy-mandated human reviews.

Concerns:

  • _data/navigation.yml: Apps sidebar/navigation restructured; nav-data changes are always human-reviewed.
  • src/styles/custom.css: Layout CSS (beacon-steps) changed; theme/layout edits affect every page.
  • src/content/docs/data-apps/python-js/index.md: Pages deleted/moved with new slugs; URL-breakage risk despite redirects.
  • + 1 more concern — see Check Run summary.

Suggested reviewers: @keboola/docs

@Iamfle4ka Iamfle4ka changed the title docs(apps): Apps section — content review + real UI screenshots PRDCT-358: Apps section — content review + real UI screenshots Jul 8, 2026
…date

# Conflicts:
#	src/content/docs/data-apps/storage-access/index.md
Nikita and others added 3 commits July 10, 2026 15:30
Per Jordan's review: manual creation lives on the same Create App screen,
so it becomes a 'Create an app manually' section of the Kai page instead
of a separate page. 301 redirect added; nav + inbound links updated;
Python/JS card listed first in the manual flow.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The overview now carries the essential info itself (what an app is,
Python/JS stack, sleep/wake, two build paths, run & share) instead of
being a link directory. The three showcase apps move onto the overview
as a 'Beyond dashboards' section; /data-apps/examples/ 301s here.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- python-js: new 'How development works' loop (repo, server-side data
  access, redeploy, logs, sleep/wake) + AI Kit block with install
  commands; VERIFY(Jordan) for a canonical skill-file download URL.
- build-locally: AI Kit install commands alongside the in-product
  Download Skill.
- what-are-apps: Streamlit de-emphasized — 'The stack: Python/JS'
  replaces the top-level comparison.
- streamlit/*: 'Streamlit apps only' scoping notes; migration-page TODO.
- reference: backend-versions/pre-installed packages scoped as
  Streamlit-only.

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

Copy link
Copy Markdown
Collaborator Author

v2 — redone per Jordan's review (new Kai backend / Python/JS)

  • Merged "Build in the UI" into "Build with Kai" — manual creation is now a section of the Kai page (same Create App screen); /data-apps/build-in-the-ui/ 301s there.
  • Overview rebuilt as an informational page — what an app is (Python/JS, governed, sleep/wake), two build paths, run & share — and "Beyond dashboards" folded into it; /data-apps/examples/ 301s to the overview. Both nav entries removed.
  • Python/JS page expanded with a "How development works" loop (repo → server-side data access → redeploy → logs → sleep/wake) and a prominent AI Kit block with install commands (also added on Build locally). VERIFY(Jordan): canonical direct-download URL for the skill file.
  • Streamlit de-emphasized and scoped: "The stack: Python/JS" replaces the top-level comparison in What are apps; all streamlit/* pages carry a "Streamlit apps only" note; the backend-versions/pre-installed-packages reference is marked Streamlit-only; migration-page TODO added.

Still to come on this branch: re-shot screenshots from the migrated project (new backend, Python/JS) — the current ~20 images still show the old backend. Blocked on the automation-browser login; structural variants for tomorrow's review are being prepared separately.

Build clean; audit MISSING IMAGES 0; both removed URLs redirect.

@Iamfle4ka Iamfle4ka changed the title PRDCT-358: Apps section — content review + real UI screenshots PRDCT-489: Apps section — content review + real UI screenshots Jul 10, 2026
…eenshots

Verified live in project 6015 (new Python/JS backend, 2026-07-10):
- Kai builds a DRAFT in a split-screen builder (chat | Preview/Code |
  Publish to Production) — no Approve card; rewrote the build flow in
  build-with-kai and getting-started steps 3-5 accordingly.
- App detail tabs: Overview/Advanced Settings/All Runs/Terminal Logs/
  Drafts/Versions; Kai apps get a private Keboola-managed Git repo;
  scaffold files App.tsx / index.ts / kbcQuery.ts.
- Deploy wizard: Python/JS backend format '1.6.1 - Python 3.11 +
  JavaScript (Node 20, Bun 1.3)'; XSmall = 8GB/1CPU (reference updated).
- Auth dropdown re-shot (None/Basic/OIDC/GitLab/GitHub/JumpCloud).
- Skill file source confirmed (ai-kit dataapp-development SKILL.md);
  direct raw download link added.
- 9 screenshots replaced with new-backend captures; published-app shots
  still pending (app start failures in the demo project — flagged).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…, skill CTAs

Per Jordan's live review of the previews:
- Remove all development-branch mentions from app pages (branches don't
  work for apps).
- Document Basic (Password) as the default auth and where the generated
  password appears (next to Open App after deploy; Kai shows it last).
- Prominent 'Get your agent started' skill-download CTA on
  build-with-kai, build-locally, python-js — a human-facing download,
  agents must not auto-fetch skills.
- Step-4 (draft preview) screenshot placeholder — to capture in the
  new demo project (264, KBC Toy Co.).

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

Copy link
Copy Markdown
Collaborator Author

Fixes from today's review call (also merged into variant B / #1013)

  • All development-branch mentions removed from app pages (branches don't work for apps).
  • Basic (Password) documented as the default — and where the password actually lives: next to Open App on the config page after deploy; new Kai shows it as the last build step.
  • "Get your agent started" skill CTA added front-and-center on Build with Kai, Build locally, and Python/JS apps — human-facing download (direct raw link) + AI Kit install.
  • Step 4 (draft Preview) gets a dedicated screenshot — being captured in the new demo project (264 / KBC Toy Co.), together with a full re-shoot there so no real data appears in any screenshot.

Noted for later: getting-started vs build-with-kai overlap (waiting on direction); Streamlit→JS migration page.

…flow

All app screenshots re-shot in the designated demo project (KBC Toy Co.,
dummy Shopify data) on the new Python/JS backend — no real data in any
frame. End-to-end flow verified by actually building and publishing a
Toy Store Sales Dashboard with Kai:

- Confirmation card DOES appear before Kai creates the app (Decline /
  Always allow / Approve) — approve step restored in getting-started
  and build-with-kai with a fresh screenshot.
- New step-4 image: split-screen draft with live Preview ('a private
  draft that updates live as Kai builds' — verbatim product copy).
- Publish mechanics documented from observation: Kai creates the prod
  app up front, works on a draft branch in the managed repo, publish =
  merge draft -> main, deploy, cleanup; final card gives URL, password,
  Open App (password masked in the shot).
- Published state shot: Active config page + Kai's URL/password card.
- Old Streamlit-era live-app image removed; standalone published-app
  shot flagged (needs manual password login).
- Advanced Settings houses env vars/theme/mappings; Drafts tab only
  while a draft exists.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…rview

- Standalone shot of the published Toy Store Sales Dashboard at its own
  URL (captured after manual password login) — restored in
  getting-started step 5 and what-are-apps.
- Overview gains a compact 'What people build' typology (dashboards,
  internal tools, narratives, configurators, agent-facing services)
  with the live-app image, leading into Beyond dashboards.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Per review feedback the CTA link becomes a solid accent button
(.skill-download-btn in custom.css). The skill file is vendored into
public/data-apps/ so the download attribute actually downloads
(cross-origin raw.githubusercontent links open in the browser instead).
Source + sync TODO noted inline (keboola/ai-kit@main).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Per Jordan + user: the two pages described the same flow. The merged
page lives at /data-apps/getting-started/ ('Build your first app with
Kai'): the 5-step walkthrough with screenshots, prompt tips folded into
step 2, refining into step 4, then the deeper mechanics (approval
model, drafts->production, data access, manual creation, agent-facing
apps). /data-apps/build-with-kai/ 301s here; nav entry 'Build with
Kai' points at it; all inbound links updated.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…lit section

The backend-version format (1.15.x - Python + Streamlit), the Python-
variants table, and the pre-installed package list are Streamlit-image
facts — they now live on /data-apps/streamlit/ (with the legacy
/components/data-apps/backend-versions/ redirect). The reference keeps
a Python/JS-focused Backend versions section: wizard format, deps from
the repository, pointer to the Streamlit section.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Replace auth-options.png with a clean frame: the Authentication Type
  dropdown open showing all six methods (None/Basic/OIDC/GitLab/GitHub/
  JumpCloud). The previous 264 frame had caught the settings-reorg modal
  instead of the dropdown.
- Publish and share had no images; add the published app's config view
  (App URL + Open in new tab + App Info) and mention the header action
  buttons.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Three distinct images, each under its heading:
- Publish the app -> the Deploy App wizard (backend size + timeout).
- Share with your team -> the Overview App URL block (copy + open).
- Manage a deployed app -> the app header + ... menu open (Copy app,
  Automate, Debug mode, Delete app). Corrected the actions list to the
  real menu.

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

Copy link
Copy Markdown
Collaborator Author

Superseded by #1013 (variant B — grouped nav, python-js merged, cleaner Diátaxis), which the team picked as canonical. Closing this one; the full Apps rework lives in #1013 (now based on main).

@Iamfle4ka Iamfle4ka closed this Jul 13, 2026
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.

2 participants