docs(fmodata): fix intent install command by eluce2 · Pull Request #145 · proofgeist/proofkit

eluce2 · 2026-03-16T14:06:06Z

Summary by CodeRabbit

Documentation
- Removed an AI Agent Integration section from one doc and added/updated AI Agent Integration guidance in Quick Start pages.
- Clarified that additional skills should be added after installing dependencies.
- Updated install examples to use a parameterized form and to reference beta/versioned tooling where applicable.
Style / Layout
- Adjusted docs layout container to use full-width styling for content pages.

vercel · 2026-03-16T14:06:14Z

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

Project	Deployment	Actions	Updated (UTC)
proofkit-docs	Ready	Preview	Mar 16, 2026 4:07pm

eluce2 · 2026-03-16T14:06:24Z

docs(fmodata): fix intent install command #145 👈 (View in Graphite)
main

This stack of pull requests is managed by Graphite. Learn more about stacking.

coderabbitai · 2026-03-16T14:07:59Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

📝 Walkthrough

Walkthrough

Removed the AI Agent Integration section from apps/docs/content/docs/fmodata/index.mdx; adjusted CLI examples in apps/docs/content/docs/fmodata/quick-start.mdx; added an AI Agent Integration section and updated install/typegen snippets in apps/docs/content/docs/fmdapi/quick-start.mdx; changed package/version resolution logic in apps/docs/src/components/CliCommand.tsx; passed containerProps to DocsLayout in two layout files.

Changes

Cohort / File(s)	Summary
FMOData docs (content edits) `apps/docs/content/docs/fmodata/index.mdx`, `apps/docs/content/docs/fmodata/quick-start.mdx`	Removed the "AI Agent Integration" section from `index.mdx`. Updated `quick-start.mdx` CLI examples and moved the ProofKit skills install instruction to run after dependencies are installed; replaced a literal install invocation with a parameterized `CliCommand` usage.
FMDAPI quick-start (content addition & updates) `apps/docs/content/docs/fmdapi/quick-start.mdx`	Added `CliCommand` import and an "AI Agent Integration" section with a `CliCommand` example. Updated package install references to `@proofkit/fmdapi@beta` and changed typegen commands to `npx` @proofkit/typegen`@beta`; updated related package.json script reference.
CLI component logic `apps/docs/src/components/CliCommand.tsx`	Reworked package string construction: detect existing version specifiers (including scoped packages), prefer `execPackage` if provided, and conditionally append `cliVersion` for `@proofkit/*` packages. Affects how the displayed/constructed CLI command is built.
Docs layout prop propagation `apps/docs/src/app/docs/(docs)/layout.tsx`, `apps/docs/src/app/docs/templates/layout.tsx`	Added `containerProps` to `DocsLayout` invocation with `className: "[--fd-layout-width:100%]"`, passing container styling through the layout.
Manifest / package script `package.json`	Updated `typegen` script references to use `npx` @proofkit/typegen`@beta` (aligned with doc snippets).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

docs: use cliVersion constant instead of hardcoded @beta #100 — Changes to apps/docs/src/components/CliCommand.tsx that alter package argument resolution and version-appending behavior.
improve agent skills and docs for AI integration #142 — Overlapping edits to fmodata docs and AI Agent Integration / CLI install guidance.

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check	❓ Inconclusive	The title mentions 'fmodata' and 'intent install command', but the changeset modifies multiple files across fmodata, fmdapi, and component files with broader documentation updates beyond just the intent install command.	Consider a more comprehensive title like 'docs: update fmodata and fmdapi with AI agent integration and beta versions' to better reflect the full scope of changes.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch docs/fmodata-intent-install-fix

📝 Coding Plan

Generate coding plan for human review comments

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

pkg-pr-new · 2026-03-16T14:10:32Z

Open in StackBlitz

@proofkit/better-auth

pnpm add https://pkg.pr.new/proofgeist/proofkit/@proofkit/better-auth@145

@proofkit/cli

pnpm add https://pkg.pr.new/proofgeist/proofkit/@proofkit/cli@145

create-proofkit

pnpm add https://pkg.pr.new/proofgeist/proofkit/create-proofkit@145

@proofkit/fmdapi

pnpm add https://pkg.pr.new/proofgeist/proofkit/@proofkit/fmdapi@145

@proofkit/fmodata

pnpm add https://pkg.pr.new/proofgeist/proofkit/@proofkit/fmodata@145

@proofkit/typegen

pnpm add https://pkg.pr.new/proofgeist/proofkit/@proofkit/typegen@145

@proofkit/webviewer

pnpm add https://pkg.pr.new/proofgeist/proofkit/@proofkit/webviewer@145

commit: 8c60071

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@apps/docs/content/docs/fmodata/quick-start.mdx`:
- Line 30: Replace the deprecated execPackage prop on the CliCommand component
with the packageName prop: locate the CliCommand instance that uses
execPackage="@tanstack/intent@latest" (the install command) and change the prop
name to packageName while keeping the same value so it becomes
packageName="@tanstack/intent@latest" to match other CliCommand usages.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: beb1dacb-3e0f-406a-a5f7-b84cb8099a9d

📥 Commits

Reviewing files that changed from the base of the PR and between 40c37a1 and 66eb384.

📒 Files selected for processing (2)

apps/docs/content/docs/fmodata/index.mdx
apps/docs/content/docs/fmodata/quick-start.mdx

apps/docs/content/docs/fmodata/quick-start.mdx

graphite-app · 2026-03-16T14:39:14Z

apps/docs/src/components/CliCommand.tsx

+    }
+    return pkg.includes("@");
+  };
+  const shouldAppendVersion = packageName.startsWith("@proofkit/") && !hasVersionSpecifier(packageName);


Runtime error: packageName is optional but accessed without null check. When packageName is undefined, calling .startsWith() will throw TypeError: Cannot read property 'startsWith' of undefined.

Fix by adding a null check:

const shouldAppendVersion = packageName?.startsWith("@proofkit/") && !hasVersionSpecifier(packageName);

Or use a guard clause:

const shouldAppendVersion = packageName && packageName.startsWith("@proofkit/") && !hasVersionSpecifier(packageName);

Suggested change

const shouldAppendVersion = packageName.startsWith("@proofkit/") && !hasVersionSpecifier(packageName);

const shouldAppendVersion = packageName?.startsWith("@proofkit/") && !hasVersionSpecifier(packageName);

Spotted by Graphite

Is this helpful? React 👍 or 👎 to let us know.

coderabbitai

🧹 Nitpick comments (1)

apps/docs/src/app/docs/(docs)/layout.tsx (1)

19-19: Minor inconsistency with rel attribute.

This link uses rel="noopener" while the equivalent link in templates/layout.tsx uses rel="noopener noreferrer". Consider adding noreferrer for consistency and additional referrer privacy.

Suggested fix

-              <a className="underline" href="https://proofgeist.com" rel="noopener" target="_blank">
+              <a className="underline" href="https://proofgeist.com" rel="noopener noreferrer" target="_blank">

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@apps/docs/src/app/docs/`(docs)/layout.tsx at line 19, Update the anchor
element in docs/(docs)/layout.tsx that currently uses rel="noopener" to use
rel="noopener noreferrer" for parity with templates/layout.tsx; locate the <a
className="underline" href="https://proofgeist.com" rel="noopener"
target="_blank"> element and change its rel attribute to "noopener noreferrer"
to add referrer privacy and maintain consistency.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@apps/docs/src/app/docs/`(docs)/layout.tsx:
- Line 19: Update the anchor element in docs/(docs)/layout.tsx that currently
uses rel="noopener" to use rel="noopener noreferrer" for parity with
templates/layout.tsx; locate the <a className="underline"
href="https://proofgeist.com" rel="noopener" target="_blank"> element and change
its rel attribute to "noopener noreferrer" to add referrer privacy and maintain
consistency.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 74c3111c-9c66-4189-a75f-2bc611f5422c

📥 Commits

Reviewing files that changed from the base of the PR and between 230601b and 581f4cf.

📒 Files selected for processing (2)

apps/docs/src/app/docs/(docs)/layout.tsx
apps/docs/src/app/docs/templates/layout.tsx

…tent docs link Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

docs(fmodata): fix intent install command

66eb384

eluce2 force-pushed the docs/fmodata-intent-install-fix branch from 8d5df3f to 66eb384 Compare March 16, 2026 14:07

vercel bot deployed to Preview March 16, 2026 14:09 View deployment

coderabbitai bot reviewed Mar 16, 2026

View reviewed changes

apps/docs/content/docs/fmodata/quick-start.mdx Outdated Show resolved Hide resolved

docs(fmodata): remove premature AI agent command

34e97f0

vercel bot deployed to Preview March 16, 2026 14:14 View deployment

docs: add AI agent install to quick starts

7fcc337

vercel bot deployed to Preview March 16, 2026 14:21 View deployment

docs: fix intent versioning and add beta tags in fmdapi quick start

230601b

vercel bot deployed to Preview March 16, 2026 14:38 View deployment

graphite-app bot reviewed Mar 16, 2026

View reviewed changes

eluce2 added 2 commits March 16, 2026 10:25

docs: keep sidebar pinned by removing docs max width

581f4cf

docs(fmodata): remove single-item CLI sidebar section

a917f5b

coderabbitai bot reviewed Mar 16, 2026

View reviewed changes

vercel bot deployed to Preview March 16, 2026 15:33 View deployment

docs: use agent-style command block for intent install

99a82ef

vercel bot deployed to Preview March 16, 2026 15:51 View deployment

docs: terminal-style AgentCommand with orange border, copy button, in…

195ba37

…tent docs link Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

vercel bot deployed to Preview March 16, 2026 16:04 View deployment

docs: move CLI to Reference, use PackageInstall with global flag

8c60071

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

vercel bot deployed to Preview March 16, 2026 16:07 View deployment

eluce2 merged commit 97994ac into main Mar 16, 2026
14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(fmodata): fix intent install command#145

docs(fmodata): fix intent install command#145
eluce2 merged 9 commits intomainfrom
docs/fmodata-intent-install-fix

eluce2 commented Mar 16, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Mar 16, 2026 •

edited

Loading

Uh oh!

eluce2 commented Mar 16, 2026

Uh oh!

coderabbitai bot commented Mar 16, 2026 •

edited

Loading

Reviews paused

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

❌ Failed checks (1 warning, 1 inconclusive)

Uh oh!

pkg-pr-new bot commented Mar 16, 2026 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

graphite-app bot Mar 16, 2026

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	const shouldAppendVersion = packageName.startsWith("@proofkit/") && !hasVersionSpecifier(packageName);
	const shouldAppendVersion = packageName?.startsWith("@proofkit/") && !hasVersionSpecifier(packageName);

Conversation

eluce2 commented Mar 16, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel bot commented Mar 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

eluce2 commented Mar 16, 2026

Uh oh!

coderabbitai bot commented Mar 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

❌ Failed checks (1 warning, 1 inconclusive)

Uh oh!

pkg-pr-new bot commented Mar 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

graphite-app bot Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

eluce2 commented Mar 16, 2026 •

edited by coderabbitai bot

Loading

vercel bot commented Mar 16, 2026 •

edited

Loading

coderabbitai bot commented Mar 16, 2026 •

edited

Loading

pkg-pr-new bot commented Mar 16, 2026 •

edited

Loading