Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
@proofkit/better-auth
@proofkit/cli
create-proofkit
@proofkit/fmdapi
@proofkit/fmodata
@proofkit/typegen
@proofkit/webviewer
commit: |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughUpdated AI onboarding docs: replaced the four-step getting-started flow with a five-step path (Install, Connect/Verify, Explore, Build, Deploy). The install-and-connect guide now documents and requires running the Connect to MCP connector script, adjusts plugin wording, and updates troubleshooting to verify the connector Web Viewer is running in Browse mode. ChangesAI Setup Documentation Restructuring
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
apps/docs/content/docs/ai/getting-started.mdx (1)
19-19:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winNode.js 26 is incorrectly listed as LTS.
Line 19 lists
Node.js 22,24, and26as LTS versions. As of May 2026, only v22 (Maintenance LTS) and v24 (Active LTS) are LTS releases. v26 is a Current release. Instead of hardcoding specific versions, point users to the official LTS list:Proposed fix
-For Node.js, choose a release that is explicitly marked LTS. Today that means **Node.js 22**, **Node.js 24**, or **Node.js 26**. If you are setting up Node for the first time, start with the [official Node.js download page](https://nodejs.org/en/download/). +For Node.js, choose a release explicitly marked **LTS** on the [official Node.js download page](https://nodejs.org/en/download/). Avoid Current releases unless you specifically need them.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@apps/docs/content/docs/ai/getting-started.mdx` at line 19, Replace the hardcoded LTS version list in the sentence starting "For Node.js, choose a release that is explicitly marked LTS. Today that means Node.js 22, Node.js 24, or Node.js 26." with a statement that directs users to the official Node.js LTS information (e.g., link to https://nodejs.org/en/about/releases or the official download page) and only mention that they should pick a release explicitly marked "LTS" rather than naming specific version numbers.
🧹 Nitpick comments (2)
apps/docs/content/docs/ai/getting-started.mdx (1)
29-31: ⚡ Quick winTighten step boundaries to avoid duplicate/competing actions.
Step 1 says to enable the plug-in if asked, while Step 2 also handles connector state and plug-in prompts. Keeping plug-in handling only in the connect step would reduce ambiguity.
Proposed wording cleanup
-Run the installer, add the ProofKit add-on to your file, and enable the plug-in if FileMaker asks. +Run the installer and add the ProofKit add-on to your file.Also applies to: 41-45
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@apps/docs/content/docs/ai/getting-started.mdx` around lines 29 - 31, Remove the duplicate plug-in enabling instruction from the install step and keep plug-in/connector prompts only in the connect step: update the "Install ProofKit and add it to your FileMaker file." paragraph to only instruct running the installer and adding the add-on, and move any mention of "enable the plug-in if FileMaker asks" into the subsequent "Connect" step (the step covering connector state and plug-in prompts around lines 41-45) so all plug-in handling is described in one place to avoid ambiguity.apps/docs/content/docs/ai/install-and-connect.mdx (1)
65-65: ⚡ Quick winTroubleshooting wording can be more explicit about action to take.
“Script is running” may be interpreted ambiguously. Suggest wording that tells users to re-run Connect to MCP and keep the connector open in Browse mode.
Proposed wording
-If the agent cannot see your file, confirm the **Connect to MCP** script is running and the connector Web Viewer is still open in Browse mode. For the full checklist, see [fmBridge troubleshooting](/docs/webviewer/fm-bridge#troubleshooting). +If the agent cannot see your file, re-run **Connect to MCP** in FileMaker Pro and confirm the connector Web Viewer remains open in Browse mode. For the full checklist, see [fmBridge troubleshooting](/docs/webviewer/fm-bridge#troubleshooting).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@apps/docs/content/docs/ai/install-and-connect.mdx` at line 65, Replace the ambiguous sentence beginning "If the agent cannot see your file, confirm the **Connect to MCP** script is running and the connector Web Viewer is still open in Browse mode." with explicit guidance that tells the user to re-run the Connect to MCP script and ensure the connector Web Viewer remains in Browse mode (e.g., "If the agent cannot see your file, re-run the **Connect to MCP** script and keep the connector Web Viewer open in Browse mode."). Update the text around that sentence to match tone and link to the same fmBridge troubleshooting section.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@apps/docs/content/docs/ai/getting-started.mdx`:
- Line 19: Replace the hardcoded LTS version list in the sentence starting "For
Node.js, choose a release that is explicitly marked LTS. Today that means
Node.js 22, Node.js 24, or Node.js 26." with a statement that directs users to
the official Node.js LTS information (e.g., link to
https://nodejs.org/en/about/releases or the official download page) and only
mention that they should pick a release explicitly marked "LTS" rather than
naming specific version numbers.
---
Nitpick comments:
In `@apps/docs/content/docs/ai/getting-started.mdx`:
- Around line 29-31: Remove the duplicate plug-in enabling instruction from the
install step and keep plug-in/connector prompts only in the connect step: update
the "Install ProofKit and add it to your FileMaker file." paragraph to only
instruct running the installer and adding the add-on, and move any mention of
"enable the plug-in if FileMaker asks" into the subsequent "Connect" step (the
step covering connector state and plug-in prompts around lines 41-45) so all
plug-in handling is described in one place to avoid ambiguity.
In `@apps/docs/content/docs/ai/install-and-connect.mdx`:
- Line 65: Replace the ambiguous sentence beginning "If the agent cannot see
your file, confirm the **Connect to MCP** script is running and the connector
Web Viewer is still open in Browse mode." with explicit guidance that tells the
user to re-run the Connect to MCP script and ensure the connector Web Viewer
remains in Browse mode (e.g., "If the agent cannot see your file, re-run the
**Connect to MCP** script and keep the connector Web Viewer open in Browse
mode."). Update the text around that sentence to match tone and link to the same
fmBridge troubleshooting section.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 2d5d1192-de66-4bf7-ab44-7cf155b61aa4
📒 Files selected for processing (2)
apps/docs/content/docs/ai/getting-started.mdxapps/docs/content/docs/ai/install-and-connect.mdx
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
apps/docs/content/docs/ai/getting-started.mdx (1)
19-19:⚠️ Potential issue | 🟠 Major | ⚡ Quick winFix incorrect Node.js LTS list in prerequisites.
Line 19 lists Node.js 22, 24, and 26 as LTS, but v26 is currently a Current release (not LTS) as of May 6, 2026. It will enter LTS in October 2026. Only v22 (Maintenance LTS) and v24 (Active LTS) are currently LTS versions. This causes the documentation to contradict its own guidance to choose explicitly marked LTS releases.
✏️ Suggested doc fix
-For Node.js, choose a release that is explicitly marked LTS. Today that means **Node.js 22**, **Node.js 24**, or **Node.js 26**. If you are setting up Node for the first time, start with the [official Node.js download page](https://nodejs.org/en/download/). +For Node.js, choose a release that is explicitly marked LTS (Active LTS or Maintenance LTS). To avoid stale version guidance, check the current LTS list on the [official Node.js releases page](https://nodejs.org/en/about/previous-releases).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@apps/docs/content/docs/ai/getting-started.mdx` at line 19, Update the Node.js LTS list in apps/docs/content/docs/ai/getting-started.mdx to only include versions that are currently LTS (Node.js 22 and Node.js 24) and remove Node.js 26 from the LTS list or mark it as "Current (enters LTS Oct 2026)"; ensure the sentence still recommends choosing an explicitly marked LTS release and adjust the parenthetical or explanatory text accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@apps/docs/content/docs/ai/getting-started.mdx`:
- Line 19: Update the Node.js LTS list in
apps/docs/content/docs/ai/getting-started.mdx to only include versions that are
currently LTS (Node.js 22 and Node.js 24) and remove Node.js 26 from the LTS
list or mark it as "Current (enters LTS Oct 2026)"; ensure the sentence still
recommends choosing an explicitly marked LTS release and adjust the
parenthetical or explanatory text accordingly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 289e97f1-d617-4dc0-b1d4-a569a806d46d
📒 Files selected for processing (2)
apps/docs/content/docs/ai/getting-started.mdxapps/docs/content/docs/ai/install-and-connect.mdx
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
apps/docs/content/docs/ai/getting-started.mdx (1)
35-37: ⚡ Quick winAlign Step 1 video callout title with Step 1 scope.
Step 1 is install-only, but the callout title says “Install and connect ProofKit,” which overlaps Step 2. Renaming it to install-only keeps the split crisp.
Proposed wording
- <Callout title="TODO: Video - Install and connect ProofKit"> + <Callout title="TODO: Video - Install ProofKit add-on"> Show downloading ProofKit and installing the add-on. </Callout>🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@apps/docs/content/docs/ai/getting-started.mdx` around lines 35 - 37, The Callout titled "TODO: Video - Install and connect ProofKit" covers both install and connect but should only cover Step 1 (install); update the Callout title to an install-only wording such as "TODO: Video - Install ProofKit" (or "Install ProofKit") in the <Callout ...> element so the title aligns with Step 1 scope and avoids overlap with Step 2's connect instructions.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@apps/docs/content/docs/ai/getting-started.mdx`:
- Line 9: The intro sentence in apps/docs/content/docs/ai/getting-started.mdx
lists six actions but the section is titled “five-step”; update the sentence
("This guide is the happy path for ProofKit v2...") to group "connect your
FileMaker file" and "verify the agent connection" into a single combined step
(e.g., "connect and verify your FileMaker agent") so the phrasing clearly
describes five steps: install, connect+verify, explore, build, and deploy; keep
the rest of the sentence structure and tone unchanged.
---
Nitpick comments:
In `@apps/docs/content/docs/ai/getting-started.mdx`:
- Around line 35-37: The Callout titled "TODO: Video - Install and connect
ProofKit" covers both install and connect but should only cover Step 1
(install); update the Callout title to an install-only wording such as "TODO:
Video - Install ProofKit" (or "Install ProofKit") in the <Callout ...> element
so the title aligns with Step 1 scope and avoids overlap with Step 2's connect
instructions.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: cdfc2116-e6bd-43d1-b26f-5c7c4c340e62
📒 Files selected for processing (1)
apps/docs/content/docs/ai/getting-started.mdx
This was referenced May 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Test plan
Summary by CodeRabbit