From 58a099fd67e1319f7e037ebd240d7b61ce8c3460 Mon Sep 17 00:00:00 2001 From: Todd Geist Date: Wed, 6 May 2026 09:12:23 -0700 Subject: [PATCH] docs: keep AI as the getting started path --- apps/docs/content/docs/better-auth/index.mdx | 2 +- apps/docs/content/docs/webviewer/index.mdx | 5 ++++ apps/docs/content/docs/webviewer/meta.json | 3 +-- apps/docs/content/docs/webviewer/package.mdx | 26 +++++++++++++------- 4 files changed, 24 insertions(+), 12 deletions(-) diff --git a/apps/docs/content/docs/better-auth/index.mdx b/apps/docs/content/docs/better-auth/index.mdx index afd7234e..752ec308 100644 --- a/apps/docs/content/docs/better-auth/index.mdx +++ b/apps/docs/content/docs/better-auth/index.mdx @@ -1,5 +1,5 @@ --- -title: Getting Started +title: Introduction description: "@proofkit/better-auth" --- diff --git a/apps/docs/content/docs/webviewer/index.mdx b/apps/docs/content/docs/webviewer/index.mdx index 5408fddd..d0fd8906 100644 --- a/apps/docs/content/docs/webviewer/index.mdx +++ b/apps/docs/content/docs/webviewer/index.mdx @@ -4,11 +4,16 @@ description: The hybrid app model and the @proofkit/webviewer bridge. --- import { Card, Cards } from "fumadocs-ui/components/card"; +import { Callout } from "fumadocs-ui/components/callout"; A ProofKit Web Viewer app is a modern web interface running inside a FileMaker Web Viewer. The web layer handles the UI. FileMaker still provides the data, security, scripts, file system access, printing, and deployment environment. This section covers both the conceptual model and the `@proofkit/webviewer` bridge package that connects the web app to FileMaker scripts and data. + + Start with the [ProofKit AI guide](/docs/ai/getting-started) for the recommended install, build, and deploy path. Use this Web Viewer section when you want to understand the hybrid app model or work directly with the bridge package. + + Learn why a Web Viewer app can be a practical architecture, not just an escape hatch. diff --git a/apps/docs/content/docs/webviewer/meta.json b/apps/docs/content/docs/webviewer/meta.json index 5bf7cd7c..0294cdf0 100644 --- a/apps/docs/content/docs/webviewer/meta.json +++ b/apps/docs/content/docs/webviewer/meta.json @@ -5,6 +5,7 @@ "root": true, "pages": [ "index", + "package", "---Concepts---", "why-webviewers", "architecture", @@ -13,8 +14,6 @@ "filemaker-scripts-as-backend", "platform-notes", "deployment-methods", - "---@proofkit/webviewer---", - "package", "---Reference---", "fmFetch", "callFmScript", diff --git a/apps/docs/content/docs/webviewer/package.mdx b/apps/docs/content/docs/webviewer/package.mdx index b46d58f2..0d86012d 100644 --- a/apps/docs/content/docs/webviewer/package.mdx +++ b/apps/docs/content/docs/webviewer/package.mdx @@ -1,27 +1,28 @@ --- -title: "Getting Started" -description: The Web Viewer bridge package. +title: "@proofkit/webviewer" +description: Use the Web Viewer bridge package directly in custom apps. --- import { Callout } from "fumadocs-ui/components/callout"; -import { Tab, Tabs } from "fumadocs-ui/components/tabs"; import { Accordion, Accordions } from "fumadocs-ui/components/accordion"; -## Purpose +Use this page when you already have a Vite app, custom Web Viewer project, or another web app where you want to use the ProofKit bridge directly. If you are new to ProofKit and want the recommended path from install to deployed FileMaker app, start with the [ProofKit AI guide](/docs/ai/getting-started). -The goal of this package is to make it easy to work with FileMaker scripts and data when building a custom webviewer integration. @proofkit/webviewer works only inside of webviewer and allows you to interact with your FileMaker solution via local scripts. +## What this package does - - Start with the [ProofKit AI guide](/docs/ai/getting-started), then come back here for lower-level Web Viewer bridge details. +`@proofkit/webviewer` makes it easier to work with FileMaker scripts and data from a custom Web Viewer integration. It runs in a FileMaker Web Viewer and lets your app interact with your FileMaker solution through local scripts. + + + The happy path starts with [ProofKit AI](/docs/ai/getting-started). Come back here when a guide points you to lower-level Web Viewer bridge details, or when you are wiring the package into an existing app yourself. This is a **client-side** package, meant to run specifically in a FileMaker Web Viewer, but it can still be used in a hosted web app, such as Next.js. However, it will cause errors if loaded in a standard browser. For more information about deployment strategies, see the [Deployment Methods](/docs/webviewer/deployment-methods) guide. For web-based applications where you're looking to interact with the Data API using a network request, check out the [@proofkit/fmdapi](/docs/fmdapi) package instead. -## Automatic Installation +## Add it to an existing app -We strongly recommend using the [ProofKit CLI](/docs/cli) to setup your project. It will also walk you through a FileMaker add-on that installs the neccesary layouts, scripts and custom functions to get you started. +The [ProofKit CLI](/docs/cli) can scaffold a full Web Viewer project and install the FileMaker add-on that provides the necessary layouts, scripts, and custom functions. Use that path when you want ProofKit to create the project structure for you. If you already have a ProofKit Web Viewer project and need to install or update the FileMaker add-on manually, run `proofkit add addon webviewer` from the project root. That copies the local add-on files; you still need to install the add-on into the FileMaker file. @@ -49,3 +50,10 @@ Demo file credentials: `admin` / `admin` + +## Related reference + +- [`fmFetch`](/docs/webviewer/fmFetch) wraps FileMaker script calls that need a result back in the Web Viewer. +- [`callFMScript`](/docs/webviewer/callFmScript) calls a FileMaker script when you do not need a result. +- [`fmBridge`](/docs/webviewer/fm-bridge) lets a local Vite dev server talk to a real connected FileMaker file. +- [Data Access](/docs/webviewer/data-access) explains the generated FileMaker data path used by ProofKit Web Viewer apps.