Skip to content

docs(ai): emphasize quitting/restarting FM + agent in install step 1#275

Merged
toddgeist merged 1 commit into
mainfrom
update-install-connect
May 19, 2026
Merged

docs(ai): emphasize quitting/restarting FM + agent in install step 1#275
toddgeist merged 1 commit into
mainfrom
update-install-connect

Conversation

@toddgeist
Copy link
Copy Markdown
Contributor

@toddgeist toddgeist commented May 19, 2026

Summary

  • Rewrites step 1 of the AI install flow to explicitly call out that users must fully quit both FileMaker Pro and their coding agent (Claude Desktop, Cursor, etc.) before installing the plugin, then restart both after.
  • Adds a callout noting that skipping the restart is the most common cause of connection failures.
  • Wording change only — no code or config altered.

Test plan

  • Docs build passes (pnpm build in apps/docs)
  • Eyeball the rendered install-and-connect page and confirm step 1 reads clearly
  • Confirm no broken links or MDX parse errors

Summary by CodeRabbit

  • Documentation
    • Updated the installation guide with clearer, more explicit instructions for ProofKit setup. Users are now directed to fully quit both FileMaker Pro and their coding agent before running the installer, and restart both applications afterward to ensure proper plug-in and integration loading.

Review Change Stack

@vercel
Copy link
Copy Markdown

vercel Bot commented May 19, 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 19, 2026 11:24pm

Request Review

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 19, 2026

⚠️ No Changeset found

Latest commit: 118a89b

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 19, 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: a20030d1-2a20-4b60-be10-fd828d898c47

📥 Commits

Reviewing files that changed from the base of the PR and between 922925f and 118a89b.

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

📝 Walkthrough

Walkthrough

This PR updates the ProofKit installation guide to clarify that users must fully quit both FileMaker Pro and their coding agent before running the installer, then restart both applications afterward to ensure the plug-in and integrations load correctly.

Changes

Installation prerequisites and post-install steps

Layer / File(s) Summary
Installation prerequisites and post-install steps
apps/docs/content/docs/ai/install-and-connect.mdx
Updates the installation guide to explicitly require users to fully quit both FileMaker Pro and their coding agent before installation, and to restart both applications after ProofKit installation completes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • proofsh/proofkit#250: Both PRs modify the same MDX guide to instruct users to quit FileMaker Pro and the coding agent before running the ProofKit installer and to reopen them afterward.
  • proofsh/proofkit#246: Both PRs modify the same install/connect guide to adjust the post-install setup flow around quitting and restarting FileMaker and the coding agent.
🚥 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 PR title 'docs(ai): emphasize quitting/restarting FM + agent in install step 1' clearly and specifically describes the main change: emphasizing the need to quit and restart FileMaker Pro and the coding agent during installation.
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-install-connect

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

Open in StackBlitz

@proofkit/better-auth

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

@proofkit/cli

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

create-proofkit

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

@proofkit/fmdapi

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

@proofkit/fmodata

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

@proofkit/typegen

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

@proofkit/webviewer

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

commit: 118a89b

@toddgeist toddgeist merged commit 61a8d44 into main May 19, 2026
20 checks passed
@toddgeist toddgeist deleted the update-install-connect branch May 19, 2026 23:26
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