Skip to content

docs: rewrite Onboarding as 3-action flow, split reference companion#25

Open
abdout wants to merge 2 commits into
mainfrom
docs/onboarding-v2
Open

docs: rewrite Onboarding as 3-action flow, split reference companion#25
abdout wants to merge 2 commits into
mainfrom
docs/onboarding-v2

Conversation

@abdout
Copy link
Copy Markdown
Contributor

@abdout abdout commented May 16, 2026

Summary

  • Rewrite content/docs/onboarding.mdx as a "Three actions" flow with elevated Pro/Max gate, post-flight checklist, and escape hatches
  • New companion content/docs/onboarding-reference.mdx carries the long-form architecture, scripts contract, and lessons from the first real run
  • Register the reference page in content/docs/meta.json (Reference group, right after claude-code)

Changes

  • content/docs/onboarding.mdx — rewrite (replaces the v1 "1./2./3." structure; fixes the %USERPROFILE%\projects\databayt\ claim that didn't match sync-repos.ps1's actual layout of ~\codebase + ~\oss\<name>)
  • content/docs/onboarding-reference.mdx — new companion (187 lines)
  • content/docs/meta.json — one line added

Plain markdown throughout (no custom MDX components introduced) — matches the convention of every other page in content/docs/.

Test plan

  • pnpm dev/en/docs/onboarding renders the 3-action flow
  • /en/docs/onboarding-reference renders the companion
  • Sidebar shows onboarding-reference in the Reference group
  • All internal /docs/<slug> links resolve
  • pnpm build passes (Vercel preview will catch this)
  • Visual scan: tables render, code blocks highlight, headings have stable anchor links

Out of scope

The v2 scripts (bootstrap.ps1, finish.ps1, doctor.ps1, maintain.ps1) belong in databayt/codebase and are tracked separately. The reference doc's scripts contract table marks them as "Planned (v2)" so readers see what's shipping vs aspirational.

Closes #24

🤖 Generated with Claude Code

Replace the v1 "1./2./3." structure with a sharper "Three actions" frame:
prereqs (Pro/Max gate elevated), the three numbered steps, the team prompt,
a verification checklist, escape hatches, manual fallback, daily entry
points, slim Next links. Long-form architecture, scripts contract, and
lessons-from-first-run move to a new Onboarding reference companion at
content/docs/onboarding-reference.mdx, slotted in the Reference group of
meta.json.

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

vercel Bot commented May 16, 2026

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

Project Deployment Actions Updated (UTC)
kun Ready Ready Preview, Comment May 16, 2026 3:42pm

Reflects the reality on the ground after PRs #29/#30/#31 land the
v2 scripts:

onboarding.mdx:
- Promotes 'irm https://kun.databayt.org/install | iex' to the
  recommended path (one paste, one UAC, three OAuth sign-ins)
- Demotes Cowork-driven flow to "Alternative" — still works for
  Pro/Max users who want narration over a bare paste
- Manual fallback updated to use databayt/kun raw URL (the codebase
  one is now tombstoned in databayt/codebase#2)
- Adds 'doctor' to Daily entry points and 'maintain -Install' to
  the manual fallback chain
- "What you end up with" mentions the scheduled task

onboarding-reference.mdx:
- Scripts contract table flipped: bootstrap, doctor, maintain are
  now Shipping (no longer 'Planned v2'); health.ps1 marked Deprecated;
  finish.ps1 reduced to 'Planned (alias for bootstrap)'
- Source-of-truth URL changed from databayt/codebase to databayt/kun
- Migration order section refreshed — 4 of 6 items checked off,
  fresh-VM test + team comms remaining

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

abdout commented May 16, 2026

Update — promoted single-paste to the recommended flow, demoted Cowork to alternative.

This PR now reflects the reality of the merged-state world rather than the pre-merge world. The doc rewrite makes sense once #29 + #30 + #31 land. Suggested merge order:

```
#29 (feat/doctor) → #30 (feat/maintain) → #31 (feat/bootstrap) → this PR (#25)
```

If this PR merges before the scripts, the recommended single-paste line will redirect to a bootstrap.ps1 that doesn't yet exist on main — readers would see a bootstrap.ps1 404 for the gap window. The Manual fallback section still uses install.ps1 directly, so a workaround exists.

Doc changes in this update:

  • onboarding.mdx now leads with irm https://kun.databayt.org/install | iex
  • Cowork-driven flow moved below as "Alternative" with a paste prompt referencing the bootstrap
  • Manual fallback URLs point at databayt/kun (codebase install.ps1 is tombstoned in chore: tombstone install.ps1 — Kun installer moved to databayt/kun codebase#2)
  • Daily entry points includes doctor
  • onboarding-reference.mdx scripts contract: bootstrap/doctor/maintain marked Shipping, health.ps1 Deprecated, source-of-truth URL switched from codebase to kun
  • Migration order section refreshed: 4 of 6 items now checked off

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.

docs: rewrite Onboarding as 3-action flow

1 participant