improvement(integrations): trim comments and fold catalog updatedAt into integrations.json

waleedlatif1 · waleedlatif1 · commit a4c10cd9ebfe · 2026-06-11T17:20:02.000-07:00
diff --git a/apps/sim/app/(landing)/components/landing-faq.tsx b/apps/sim/app/(landing)/components/landing-faq.tsx
@@ -15,15 +15,9 @@ interface LandingFAQProps {
 }
 
 /**
- * Accordion FAQ for landing pages.
- *
- * Every answer stays mounted and is collapsed via animated height rather than
- * being rendered on demand: AI crawlers (GPTBot, ClaudeBot, PerplexityBot) and
- * non-rendering search crawlers only read the served HTML, so the full Q&A
- * text must exist in the initial document to be indexed or cited. Keeping the
- * answers in the DOM also keeps the FAQPage JSON-LD emitted by consuming pages
- * aligned with visible content, as Google's structured-data policy requires.
- * Questions render as h3 headings so each Q&A forms an extractable section.
+ * Accordion FAQ for landing pages. Answers stay mounted (collapsed via
+ * animated height) so non-JS crawlers see the full Q&A text and FAQPage
+ * JSON-LD always matches visible content.
  */
 export function LandingFAQ({ faqs }: LandingFAQProps) {
   const baseId = useId()
diff --git a/apps/sim/app/(landing)/integrations/(shell)/[slug]/opengraph-image.tsx b/apps/sim/app/(landing)/integrations/(shell)/[slug]/opengraph-image.tsx
@@ -9,12 +9,8 @@ export const size = {
   height: 630,
 }
 
-/**
- * Reads the raw catalog JSON instead of the `@/lib/integrations` barrel: the
- * barrel imports `@/blocks/registry`, which is far too heavy for the edge OG
- * bundle. The JSON is the same generated source of truth.
- */
-const integrations = integrationsJson as readonly Integration[]
+/** Raw catalog JSON, not the barrel — keeps `@/blocks/registry` out of the OG bundle. */
+const integrations = integrationsJson.integrations as readonly Integration[]
 const bySlug = new Map(integrations.map((i) => [i.slug, i]))
 
 const AUTH_LABEL: Record<AuthType, string> = {
diff --git a/apps/sim/app/(landing)/integrations/(shell)/[slug]/page.tsx b/apps/sim/app/(landing)/integrations/(shell)/[slug]/page.tsx
@@ -86,10 +86,7 @@ const AUTH_STEP: Record<AuthType, (name: string) => string> = {
   none: () => 'No authentication is needed — the block works as soon as you drop it in.',
 }
 
-/**
- * Human-readable catalog refresh date, shown on the page and emitted as
- * `dateModified` so search and answer engines can see content freshness.
- */
+/** Human-readable catalog refresh date for the visible last-updated line. */
 const UPDATED_AT_DISPLAY = new Date(`${INTEGRATIONS_UPDATED_AT}T00:00:00Z`).toLocaleDateString(
   'en-US',
   { year: 'numeric', month: 'long', day: 'numeric', timeZone: 'UTC' }
@@ -134,10 +131,7 @@ function mentionifyPromptForNames(prompt: string, names: readonly string[]): str
   return prompt.replace(regex, (match) => `@${match}`)
 }
 
-/**
- * Lowercases only the first character so acronyms inside tool names survive
- * ("Get PR Details" → "get PR Details").
- */
+/** Lowercases only the first character so acronyms in tool names survive. */
 function lowercaseFirst(value: string): string {
   return value.charAt(0).toLowerCase() + value.slice(1)
 }
@@ -149,26 +143,15 @@ function toProseList(items: string[]): string {
   return `${items.slice(0, -1).join(', ')}, and ${items[items.length - 1]}`
 }
 
-/**
- * "a" vs "an" for a service name. Vowel-letter heuristic, except U-names,
- * which almost always read as "you" ("a Unipile block").
- */
+/** "a" vs "an" for a service name; U-names read as "you", so they take "a". */
 function articleFor(name: string): string {
   return /^[aeio]/i.test(name) ? 'an' : 'a'
 }
 
 /**
- * Generates the per-integration FAQ from catalog metadata.
- *
- * Authoring constraints (SEO/GEO):
- * - Every answer opens with a direct, self-contained answer and carries
- *   integration-specific facts (tool counts and names, trigger events, auth
- *   mode, related integrations), so no two pages share an identical answer.
- * - Catalog-generic questions (pricing, agent tool use) live once on the
- *   /integrations index FAQ instead of repeating across every page —
- *   duplicated Q&A across many pages is a scaled-content anti-pattern.
- * - The full Q&A text is server-rendered by `LandingFAQ` and mirrored 1:1
- *   into the page's FAQPage JSON-LD.
+ * Generates the per-integration FAQ. Answers lead with a direct answer and
+ * carry integration-specific facts; catalog-generic questions live once on
+ * the /integrations index FAQ instead of repeating across every page.
  */
 function buildFAQs(integration: Integration, relatedNames: string[]): FAQItem[] {
   const { name, description, operations, triggers, authType } = integration
@@ -294,9 +277,8 @@ export async function generateMetadata({
       'AI agent integrations',
       'AI agent builder',
     ],
-    // og:image / twitter:image come from the sibling `opengraph-image.tsx`
-    // file convention — Next serves it at a hash-suffixed URL, so hardcoding
-    // the URL here would 404. File-based metadata is injected automatically.
+    // og:image/twitter:image come from the sibling opengraph-image.tsx —
+    // Next serves it at a hash-suffixed URL, so hardcoding it here 404s.
     openGraph: {
       title: `${name} Integration | Sim AI Workspace`,
       description: `Connect ${name} to ${INTEGRATION_COUNT - 1}+ tools using AI agents. ${sentenceWithTerminalPunctuation(truncate(description, 100))}`,
@@ -454,7 +436,6 @@ export default async function IntegrationPage({ params }: { params: Promise<{ sl
           {description}
         </p>
 
-        {/* Atomic product summary for AI citation (see .claude/rules/landing-seo-geo.md) */}
         <p className='sr-only'>
           {name} is a {categoryLabel} integration for Sim, the AI workspace where teams build and
           deploy AI agents. Sim&apos;s {name} integration provides{' '}
diff --git a/apps/sim/app/(landing)/integrations/(shell)/opengraph-image.tsx b/apps/sim/app/(landing)/integrations/(shell)/opengraph-image.tsx
@@ -8,12 +8,8 @@ export const size = {
   height: 630,
 }
 
-/**
- * Reads the raw catalog JSON instead of the `@/lib/integrations` barrel: the
- * barrel imports `@/blocks/registry`, which is far too heavy for the edge OG
- * bundle. The JSON is the same generated source of truth.
- */
-const integrations = integrationsJson as readonly Integration[]
+/** Raw catalog JSON, not the barrel — keeps `@/blocks/registry` out of the OG bundle. */
+const integrations = integrationsJson.integrations as readonly Integration[]
 const TOTAL_TOOL_COUNT = integrations.reduce((sum, i) => sum + i.operationCount, 0)
 const OAUTH_COUNT = integrations.filter((i) => i.authType === 'oauth').length
 const TRIGGER_INTEGRATION_COUNT = integrations.filter((i) => i.triggerCount > 0).length
diff --git a/apps/sim/app/(landing)/integrations/(shell)/page.tsx b/apps/sim/app/(landing)/integrations/(shell)/page.tsx
@@ -20,12 +20,8 @@ const TRIGGER_INTEGRATION_COUNT = allIntegrations.filter((i) => i.triggerCount >
 const TOTAL_TOOL_COUNT = allIntegrations.reduce((sum, i) => sum + i.operationCount, 0)
 
 /**
- * Catalog-level FAQ. Questions that read the same for every integration
- * (pricing, agent tool use, how integrations work) live here exactly once —
- * repeating identical Q&A across every per-integration page is a
- * scaled-content anti-pattern, and Google's FAQ guidance says repeated FAQs
- * should be marked up on a single page. Answers lead with a direct answer and
- * concrete catalog numbers for AI-engine extraction.
+ * Catalog-level FAQ. Questions that read the same for every integration live
+ * here exactly once instead of repeating across all per-integration pages.
  */
 const CATALOG_FAQS: FAQItem[] = [
   {
@@ -76,9 +72,8 @@ export const metadata: Metadata = {
     ...TOP_NAMES.flatMap((n) => [`${n} integration`, `${n} automation`]),
     ...allIntegrations.slice(0, 20).map((i) => `${i.name} automation`),
   ],
-  // og:image / twitter:image come from the sibling `opengraph-image.tsx` file
-  // convention — Next serves it at a hash-suffixed URL, so hardcoding the URL
-  // here would 404. File-based metadata is injected automatically.
+  // og:image/twitter:image come from the sibling opengraph-image.tsx —
+  // Next serves it at a hash-suffixed URL, so hardcoding it here 404s.
   openGraph: {
     title: 'Integrations | Sim AI Workspace',
     description: `Connect ${INTEGRATION_COUNT}+ apps in Sim's AI workspace. Build agents that link ${TOP_NAMES.join(', ')}, and every tool your team uses.`,
@@ -215,7 +210,7 @@ export default function IntegrationsPage() {
 
         <div className='h-px w-full bg-[var(--landing-bg-elevated)]' />
 
-        {/* FAQ — catalog-level questions, asked once for all integrations */}
+        {/* FAQ */}
         <section aria-labelledby='integrations-faq-heading' className='px-6 py-10'>
           <h2
             id='integrations-faq-heading'
diff --git a/apps/sim/app/(landing)/models/(shell)/[provider]/[model]/page.tsx b/apps/sim/app/(landing)/models/(shell)/[provider]/[model]/page.tsx
@@ -54,9 +54,8 @@ export async function generateMetadata({
       `${provider.name} model pricing`,
       ...model.capabilityTags,
     ],
-    // og:image / twitter:image come from the sibling `opengraph-image.tsx`
-    // file convention — Next serves it at a hash-suffixed URL, so hardcoding
-    // the URL here would 404. File-based metadata is injected automatically.
+    // og:image/twitter:image come from the sibling opengraph-image.tsx —
+    // Next serves it at a hash-suffixed URL, so hardcoding it here 404s.
     openGraph: {
       title: `${model.displayName} Pricing, Context Window, and Features | Sim`,
       description: `${model.displayName} by ${provider.name}: pricing, context window, and model capability details.`,
diff --git a/apps/sim/app/(landing)/models/(shell)/[provider]/page.tsx b/apps/sim/app/(landing)/models/(shell)/[provider]/page.tsx
@@ -55,9 +55,8 @@ export async function generateMetadata({
       `${provider.name} AI models`,
       ...provider.models.slice(0, 6).map((model) => model.displayName),
     ],
-    // og:image / twitter:image come from the sibling `opengraph-image.tsx`
-    // file convention — Next serves it at a hash-suffixed URL, so hardcoding
-    // the URL here would 404. File-based metadata is injected automatically.
+    // og:image/twitter:image come from the sibling opengraph-image.tsx —
+    // Next serves it at a hash-suffixed URL, so hardcoding it here 404s.
     openGraph: {
       title: `${provider.name} Models | Sim`,
       description: `Explore ${provider.modelCount} ${provider.name} models with pricing and capability details.`,
diff --git a/apps/sim/app/(landing)/models/(shell)/page.tsx b/apps/sim/app/(landing)/models/(shell)/page.tsx
@@ -63,9 +63,8 @@ export const metadata: Metadata = {
     'Mistral models',
     ...TOP_MODEL_PROVIDERS.map((provider) => `${provider} models`),
   ],
-  // og:image / twitter:image come from the sibling `opengraph-image.tsx` file
-  // convention — Next serves it at a hash-suffixed URL, so hardcoding the URL
-  // here would 404. File-based metadata is injected automatically.
+  // og:image/twitter:image come from the sibling opengraph-image.tsx —
+  // Next serves it at a hash-suffixed URL, so hardcoding it here 404s.
   openGraph: {
     title: 'AI Models Directory | Sim',
     description: `Explore ${TOTAL_MODELS}+ AI models across ${TOTAL_MODEL_PROVIDERS} providers with pricing, context windows, and capability details.`,
diff --git a/apps/sim/app/(landing)/og-utils.tsx b/apps/sim/app/(landing)/og-utils.tsx
@@ -69,11 +69,7 @@ interface LandingOgImageProps {
   domainLabel?: string
 }
 
-/**
- * Shared dynamic OG image for landing catalog pages (models, integrations).
- * Used from edge OG routes — callers must keep heavy registries (blocks,
- * tools, icons) out of their import graph.
- */
+/** Shared dynamic OG image for landing catalog pages (models, integrations). */
 export async function createLandingOgImage({
   eyebrow,
   title,
diff --git a/apps/sim/lib/integrations/index.ts b/apps/sim/lib/integrations/index.ts
@@ -14,20 +14,19 @@
 
 import { stripVersionSuffix } from '@sim/utils/string'
 import integrationsJson from '@/lib/integrations/integrations.json'
-import integrationsMeta from '@/lib/integrations/integrations-meta.json'
 import type { Integration } from '@/lib/integrations/types'
 import { getAllBlockMeta } from '@/blocks/registry'
 
 /** All integrations surfaced in the catalog, ordered by `scripts/generate-docs.ts`. */
-export const INTEGRATIONS: readonly Integration[] = integrationsJson as readonly Integration[]
+export const INTEGRATIONS: readonly Integration[] =
+  integrationsJson.integrations as readonly Integration[]
 
 /**
- * ISO date (YYYY-MM-DD) of the last real catalog content change, stamped by
- * `scripts/generate-docs.ts` only when `integrations.json` actually changes.
+ * ISO date of the last real catalog change, stamped by `scripts/generate-docs.ts`.
  * Drives sitemap `lastModified`, JSON-LD `dateModified`, and the visible
- * last-updated line on integration pages — never fabricate freshness here.
+ * last-updated line on integration pages.
  */
-export const INTEGRATIONS_UPDATED_AT: string = integrationsMeta.catalogUpdatedAt
+export const INTEGRATIONS_UPDATED_AT: string = integrationsJson.updatedAt
 
 /** A curated `from → to` block-pair workflow surfaced on the landing page. */
 export interface PopularWorkflow {
diff --git a/apps/sim/lib/integrations/integrations-meta.json b/apps/sim/lib/integrations/integrations-meta.json
diff --git a/apps/sim/lib/integrations/integrations.json b/apps/sim/lib/integrations/integrations.json
diff --git a/apps/sim/lib/integrations/oauth-service.ts b/apps/sim/lib/integrations/oauth-service.ts
diff --git a/scripts/generate-docs.ts b/scripts/generate-docs.ts
