Skip to content

docs: rewrite onboarding for single-paste cold start#37

Open
abdout wants to merge 1 commit into
feat/linux-systemdfrom
docs/onboarding-rewrite
Open

docs: rewrite onboarding for single-paste cold start#37
abdout wants to merge 1 commit into
feat/linux-systemdfrom
docs/onboarding-rewrite

Conversation

@abdout
Copy link
Copy Markdown
Contributor

@abdout abdout commented May 18, 2026

Summary

Rewrites content/docs/onboarding.mdx so a fresh hire on Windows, macOS, or Linux can paste one line, watch numbered output, and end with a green doctor. Also fixes 4 stale URLs in content/docs/claude-code.mdx.

Why

The current /docs/onboarding page actively misleads:

  • Tells users to paste irm https://raw.githubusercontent.com/databayt/codebase/main/.claude/scripts/install.ps1 | iexURL 404s (scripts moved to databayt/kun)
  • Windows-only — ignores bootstrap.sh, install.sh, maintain.sh, doctor.sh that ship in this PR chain
  • Hides the canonical kun.databayt.org/install redirect already wired in next.config.ts:16
  • Hides bootstrap.ps1 entirely (a 360-line 16-step installer with logging, OAuth batching, GitHub tracking issue, and dry-run mode)
  • No mention of roles (engineer | business | content | ops)
  • Doesn't document /doctor and /maintain (shipped in commit eb38508)
  • Wrong repo-layout claim (%USERPROFILE%\projects\databayt\ vs the actual ~/codebase + ~/oss/*)

What's new in the rewrite

  • Quick start — single-paste one-liners for Windows + macOS/Linux up top
  • Before you start — accounts a new hire needs first (GitHub, Anthropic, JetBrains)
  • What you end up with — accurate end-state table matching bootstrap.ps1 reality
  • Roles — 4-role table with what each bundle includes
  • The 16 steps — table of every step bootstrap runs, what it does, skip flags
  • OAuth batch — describes the beep + 3 sign-ins at step 12
  • Flags-Role, -Track, -DryRun, -SkipOAuth, -SkipWebStorm, -SkipCowork
  • Watch it run (Cowork-driven) — kept as optional alternative for Pro/Max users
  • Troubleshooting — UAC declined, gh auth retry, doctor exit codes 0/1/2/3, plugin marketplace fallback
  • Daily entry points — adds c "/doctor" and c "/maintain install"
  • Manual fallback — kept for air-gapped setups, all URLs corrected to databayt/kun

claude-code.mdx fix

4 stale databayt/codebase/main/.claude/scripts/... URLs swapped to databayt/kun/.... "Config Sources" section's dual-source claim corrected — databayt/kun is now the single source of truth.

Dependencies

Stacks on feat/linux-systemd (PR #36) since the new doc describes features only present in that branch (bootstrap.sh, Linux systemd, /install.sh redirect, etc.). Final merge order:

#29 → #30 → #31 → #32 → #33 → #34 → #35 → #36 → this PR

After the chain merges, rebase onto main becomes a docs-only diff.

Test plan

  • pnpm build — MDX compiles cleanly
  • Local pnpm dev/en/docs/onboarding renders without layout breaks
  • https://kun.databayt.org/install (after merge) — confirms the doc's leading one-liner resolves
  • grep -r "databayt/codebase/main/.claude/scripts" content/ — zero hits
  • Optional: paste the one-liner on a clean Windows Sandbox + Linux VM, end-to-end, confirm the 16-step table and "what you end up with" match reality

Screenshots

(none — doc-only change, render locally to spot-check)

Refs #28

🤖 Generated with Claude Code

Lead with the canonical irm /install / curl /install.sh one-liners
that next.config.ts:16 already wires up. The page previously sent
new hires to databayt/codebase/.../install.ps1 — a URL that 404s,
since scripts moved to databayt/kun. It also forced a Cowork-first
flow that excludes Team/Enterprise plans and hides bootstrap.ps1's
16-step automated flow.

Rewrite covers:
- Single-paste flow for Windows + macOS/Linux (no more Windows-only)
- "Before you start" prerequisites — accounts a new hire needs first
- Roles (engineer / business / content / ops) with their bundles
- The 16-step table — what bootstrap actually does
- OAuth batch UX — the beep + 3 sign-ins at step 12
- Flags (-Role, -Track, -DryRun, -SkipOAuth, -SkipWebStorm, -SkipCowork)
- Cowork-driven path kept as optional for Pro/Max users
- Troubleshooting table — doctor exit codes, gh auth retry, etc.
- /doctor and /maintain added to daily entry points

Also fixes claude-code.mdx — 4 stale install URLs swapped to
databayt/kun, "Config Sources" dual-source claim corrected.

Refs #28

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 18, 2026

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

Project Deployment Actions Updated (UTC)
kun Ready Ready Preview, Comment May 18, 2026 4:40am

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.

1 participant