Skip to content

docs: add GitHub workflow guide for AI docs#252

Open
eluce2 wants to merge 2 commits intomainfrom
docs/ai-github-workflow
Open

docs: add GitHub workflow guide for AI docs#252
eluce2 wants to merge 2 commits intomainfrom
docs/ai-github-workflow

Conversation

@eluce2
Copy link
Copy Markdown
Collaborator

@eluce2 eluce2 commented May 7, 2026

Summary

  • New AI docs guide at /docs/ai/github-workflow aimed at FileMaker devs new to Git, anchored to the shared-user model they know.
  • Reusable ThemedImage MDX component renders light/dark SVG variants via Tailwind dark: classes (no JS toggle, no hydration flicker).
  • Two new themed diagrams in public/diagrams/: shared-user-model and github-flow.

Test plan

  • pnpm run ci passes
  • Visit /docs/ai/github-workflow locally; verify both diagrams render
  • Toggle theme; verify correct SVG variant shows in each mode with no background chrome
  • Confirm page appears as the last entry under "Guides" in the AI docs sidebar

🤖 Generated with Claude Code

Summary by CodeRabbit

  • New Features

    • Theme-aware images that switch for light/dark modes.
    • New download flow: a platform-aware dialog that collects email and shows confirmation.
    • New UI primitives: standardized dialog, select, and button components for consistent interactions.
  • Documentation

    • New "GitHub Workflow" guide covering Git basics, repo publishing, branching, pull requests, and AI-assisted Git prompts.

Adds a friendly Git/GitHub intro for FileMaker devs anchored to the
shared user model they know, with light/dark themed diagrams via a new
ThemedImage MDX component.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 7, 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 8, 2026 5:42pm

Request Review

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 7, 2026

⚠️ No Changeset found

Latest commit: 214b8c3

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

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 7, 2026

Open in StackBlitz

@proofkit/better-auth

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

@proofkit/cli

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

create-proofkit

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

@proofkit/fmdapi

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

@proofkit/fmodata

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

@proofkit/typegen

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

@proofkit/webviewer

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

commit: 214b8c3

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 7, 2026

Review Change Stack
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: fc429f2e-3bb2-452d-98dc-50a55e9beb6c

📥 Commits

Reviewing files that changed from the base of the PR and between d21d27c and e660420.

⛔ Files ignored due to path filters (4)
  • apps/docs/public/diagrams/github-flow-dark.svg is excluded by !**/*.svg
  • apps/docs/public/diagrams/github-flow-light.svg is excluded by !**/*.svg
  • apps/docs/public/diagrams/shared-user-model-dark.svg is excluded by !**/*.svg
  • apps/docs/public/diagrams/shared-user-model-light.svg is excluded by !**/*.svg
📒 Files selected for processing (4)
  • apps/docs/content/docs/ai/github-workflow.mdx
  • apps/docs/content/docs/ai/meta.json
  • apps/docs/src/components/ThemedImage.tsx
  • apps/docs/src/mdx-components.tsx

📝 Walkthrough

Walkthrough

This PR adds a new "GitHub Workflow" documentation guide aimed at FileMaker developers learning Git and GitHub, along with a reusable ThemedImage component for theme-aware image rendering. The guide covers Git's distributed model, core terminology, hosted repository benefits, and publishing workflows, while the component infrastructure enables conditional light/dark image display in documentation.

Changes

GitHub Workflow Guide and Themed Image Component

Layer / File(s) Summary
Component Type Definition
apps/docs/src/components/ThemedImage.tsx
ThemedImageProps interface defines required light/dark image sources, shared accessibility text, dimensions, and optional CSS class merging.
Component Implementation
apps/docs/src/components/ThemedImage.tsx
ThemedImage renders two conditional next/image elements with theme-specific CSS utilities for visibility control, sharing dimensions and alt text.
Component Registration
apps/docs/src/mdx-components.tsx
ThemedImage is imported and added to the returned MDX components map in getMDXComponents, making it available in MDX documents.
Documentation Structure
apps/docs/content/docs/ai/github-workflow.mdx
New MDX page with frontmatter, step component imports, and narrative introduction to Git workflows for FileMaker developers.
Core Guide Content
apps/docs/content/docs/ai/github-workflow.mdx
Sections explain Git's mental model, key terminology (commit, push, pull, branch, merge), and benefits of hosted repositories with callout boxes clarifying concepts.
Workflow and Publishing Guidance
apps/docs/content/docs/ai/github-workflow.mdx
Provides example prompts for delegating Git operations to an AI agent and step-by-step instructions for creating a GitHub account and publishing via CLI.
Documentation Registration
apps/docs/content/docs/ai/meta.json
Adds github-workflow entry to the pages array under the "Guides" section in documentation metadata.

🎯 1 (Trivial) | ⏱️ ~4 minutes

🚥 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 pull request title clearly and specifically summarizes the main addition: a new GitHub workflow guide for the AI documentation targeting developers new to Git.
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 docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/ai-github-workflow

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

- replace direct download links with email capture
- wire docs to varlock env loading
- add shared dialog and select primitives
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