Skip to content

docs: update installer restart guidance#250

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

docs: update installer restart guidance#250
toddgeist merged 1 commit intomainfrom
update-getting-started-3

Conversation

@toddgeist
Copy link
Copy Markdown
Contributor

@toddgeist toddgeist commented May 6, 2026

Summary

  • Clarifies that FileMaker Pro and the coding agent should be quit before running the installer.
  • Adds guidance to reopen both apps after installation so the new ProofKit plug-in and integrations load.

Test plan

  • pnpm run ci

Summary by CodeRabbit

  • Documentation
    • Updated installation instructions to include explicit steps for quitting and reopening FileMaker Pro and your coding agent before and after running the ProofKit installer to ensure proper plug-in and integration loading.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 6, 2026

⚠️ No Changeset found

Latest commit: c6c12a2

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 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 10:15pm

Request Review

@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@250

@proofkit/cli

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

create-proofkit

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

@proofkit/fmdapi

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

@proofkit/fmodata

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

@proofkit/typegen

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

@proofkit/webviewer

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

commit: c6c12a2

@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: eda58b42-9d68-44a5-ac8f-15abc1a2f289

📥 Commits

Reviewing files that changed from the base of the PR and between ccd8bd4 and c6c12a2.

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

📝 Walkthrough

Walkthrough

The installation documentation for FileMaker Pro ProofKit integration is updated to include explicit pre-installation steps: users must quit FileMaker Pro and their coding agent before running the installer, then reopen both applications afterward to allow plug-ins and integrations to load.

Changes

Installation Instructions Update

Layer / File(s) Summary
Documentation
apps/docs/content/docs/ai/install-and-connect.mdx
Pre-installation requirement added: quit FileMaker Pro and coding agent before running the installer. Post-installation step updated: reopen both applications to load ProofKit plug-ins and integrations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • proofsh/proofkit#246: Modifies the same install-and-connect documentation file with related workflow updates.
🚥 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 installer restart guidance' directly and clearly summarizes the main change: updating documentation with guidance about restarting applications during the installation process.
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-3

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.


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

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