Skip to content

docs: update getting started overview#249

Merged
toddgeist merged 1 commit intomainfrom
update-getting-started-again
May 6, 2026
Merged

docs: update getting started overview#249
toddgeist merged 1 commit intomainfrom
update-getting-started-again

Conversation

@toddgeist
Copy link
Copy Markdown
Contributor

@toddgeist toddgeist commented May 6, 2026

Summary

  • Removes placeholder TODO video callouts from the Getting Started guide.
  • Clarifies that the page is an overview for the ProofKit v2 happy path.
  • Adds Install and Connect to the What to read next section.

Test plan

  • pnpm run ci

Summary by CodeRabbit

  • Documentation
    • Restructured the AI Getting Started guide with a step-by-step layout and practical inline guidance, replacing placeholder content throughout the onboarding process.
    • Enhanced clarity with actionable instructions for installation, connection, exploration, building, and deployment workflows.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 6, 2026

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

Project Deployment Actions Updated (UTC)
proofkit-docs Ready Ready Preview May 6, 2026 9:57pm

Request Review

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 6, 2026

⚠️ No Changeset found

Latest commit: e53ab9e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 6, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: eec154f0-df17-4a84-98e0-76cba760f0fe

📥 Commits

Reviewing files that changed from the base of the PR and between 3f63bf3 and e53ab9e.

📒 Files selected for processing (1)
  • apps/docs/content/docs/ai/getting-started.mdx

📝 Walkthrough

Walkthrough

The Getting Started documentation page is restructured to use a Steps-based guided layout. Callout video placeholders are replaced with inline step instructions for Install, Connect, Explore, Build, and Deploy. Component imports are updated and overview text is added to describe the happy path.

Changes

Getting Started Page Restructuring

Layer / File(s) Summary
Component Imports
apps/docs/content/docs/ai/getting-started.mdx
Steps and Step components are imported to replace inline Callout video placeholders.
Overview & Guidance Structure
apps/docs/content/docs/ai/getting-started.mdx
Overview text is added describing the happy path and linking to focused guides. The entire step sequence is wrapped in a Steps component.
Step-by-Step Inline Guidance
apps/docs/content/docs/ai/getting-started.mdx
Each of the five steps (Install, Connect, Explore, Build, Deploy) is updated with concrete inline instructions replacing video Callouts. Each step includes actionable guidance and relevant documentation links.
Navigation Links
apps/docs/content/docs/ai/getting-started.mdx
The "What to read next" section is simplified, replacing the Deploy video Callout with a direct bullet link to Install and Connect.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • proofsh/proofkit#246: Restructures the same getting-started.mdx file into a multi-step guided layout with the same five steps (Install, Connect, Explore, Build, Deploy).
  • proofsh/proofkit#247: Applies the same Steps/Step UI restructuring pattern to replace Callout-based video intros across other documentation pages.
  • proofsh/proofkit#239: Modifies the same file with overlapping changes, adding chat-vs-code guidance and expanding the Explore step content.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: update getting started overview' is partially related to the changeset. It mentions updating the getting started overview, which is accurate, but is overly broad and doesn't capture the main substance of the change: replacing video placeholders with a Steps-based guided layout and restructuring the content.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update-getting-started-again

Comment @coderabbitai help to get the list of available commands and usage tips.

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 6, 2026

Open in StackBlitz

@proofkit/better-auth

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/better-auth@249

@proofkit/cli

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/cli@249

create-proofkit

pnpm add https://pkg.pr.new/proofsh/proofkit/create-proofkit@249

@proofkit/fmdapi

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/fmdapi@249

@proofkit/fmodata

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/fmodata@249

@proofkit/typegen

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/typegen@249

@proofkit/webviewer

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/webviewer@249

commit: e53ab9e

@toddgeist toddgeist merged commit 0e1f909 into main May 6, 2026
13 checks passed
@toddgeist toddgeist deleted the update-getting-started-again branch May 6, 2026 22:00
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