Skip to content

docs(ai): simplify install step 1 to post-install restart only#276

Merged
toddgeist merged 1 commit into
mainfrom
tighten-install-step-1
May 20, 2026
Merged

docs(ai): simplify install step 1 to post-install restart only#276
toddgeist merged 1 commit into
mainfrom
tighten-install-step-1

Conversation

@toddgeist
Copy link
Copy Markdown
Contributor

@toddgeist toddgeist commented May 20, 2026

Summary

  • Removes the redundant pre-install "quit both apps" guidance from install step 1
  • The post-install restart already covers loading the new plug-in and integrations, so the quit-before instruction was unnecessary
  • Follow-up to docs(ai): emphasize quitting/restarting FM + agent in install step 1 #275, which originally introduced both the quit-before and restart-after steps

Test plan

  • Verify docs build passes (pnpm build in apps/docs)
  • Eyeball the install-and-connect page to confirm the simplified step reads naturally

Summary by CodeRabbit

  • Documentation
    • Revised ProofKit installation instructions with updated guidance on obtaining platform-specific installers and clarified post-installation procedures requiring a full restart of the application and coding agent.

Review Change Stack

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 20, 2026

⚠️ No Changeset found

Latest commit: 4bfbae7

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

@vercel
Copy link
Copy Markdown

vercel Bot commented May 20, 2026

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

Project Deployment Actions Updated (UTC)
proofkit-docs Ready Ready Preview, Comment May 20, 2026 12:09am

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 20, 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: 90ef8c6c-9b2e-4df7-9df1-22123372357e

📥 Commits

Reviewing files that changed from the base of the PR and between 61a8d44 and 4bfbae7.

📒 Files selected for processing (1)
  • apps/docs/content/docs/ai/install-and-connect.mdx

📝 Walkthrough

Walkthrough

This PR updates the ProofKit installer instructions in the documentation. It adds a platform-specific installer download step and adjusts the restart guidance, clarifying that FileMaker Pro and the coding agent must be fully restarted after installation completes.

Changes

Installation Documentation

Layer / File(s) Summary
Installer flow wording clarification
apps/docs/content/docs/ai/install-and-connect.mdx
The installer section now introduces a "Get the installer for your platform" step and clarifies that users must "fully restart both FileMaker Pro and your coding agent" when installation completes, removing the previous explicit pre-installation quit instruction.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • proofsh/proofkit#250: Updates the same installer guidance file with pre-install and post-install steps for FileMaker Pro and coding agent quit/restart behavior.
  • proofsh/proofkit#275: Modifies the same install-and-connect.mdx file to manage FileMaker Pro and coding agent restart/quit behavior in the installation steps.
  • proofsh/proofkit#246: Changes the same documentation file with adjustments to the post-install restart/enable workflow around running connect steps.
🚥 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 clearly summarizes the main change: simplifying install step 1 by removing pre-install quit guidance and keeping only the post-install restart instruction.
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 tighten-install-step-1

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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 20, 2026

Open in StackBlitz

@proofkit/better-auth

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

@proofkit/cli

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

create-proofkit

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

@proofkit/fmdapi

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

@proofkit/fmodata

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

@proofkit/typegen

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

@proofkit/webviewer

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

commit: 4bfbae7

@toddgeist toddgeist merged commit a41abc6 into main May 20, 2026
20 checks passed
@toddgeist toddgeist deleted the tighten-install-step-1 branch May 20, 2026 00:11
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